Files
kornia--kornia/docs/source/contrib.rst
T
wehub-resource-sync 3a2c66702c
Tests on CPU (scheduled) / check-skip (push) Has been cancelled
Tests on CPU (scheduled) / pre-tests (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-ubuntu (float32) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-ubuntu (float64) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.11, float32, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.11, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.11, float64, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.11, float64, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.12, float32, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.12, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.12, float64, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.12, float64, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.13, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-windows (3.13, float64, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-mac (3.11, float32, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-mac (3.11, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-mac (3.12, float32, 2.5.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-mac (3.12, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / tests-cpu-mac (3.13, float32, 2.9.1) (push) Has been cancelled
Tests on CPU (scheduled) / coverage (push) Has been cancelled
Tests on CPU (scheduled) / typing (push) Has been cancelled
Tests on CPU (scheduled) / tutorials (push) Has been cancelled
Tests on CPU (scheduled) / docs (push) Has been cancelled
Lint / TOML Format (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:49:27 +08:00

209 lines
4.9 KiB
ReStructuredText

kornia.contrib
==============
.. meta::
:name: description
:content: "The Kornia.contrib module provides models and utilities for deep learning applications, including base models and the EfficientViT architecture. The module offers configurable, efficient Vision Transformer (ViT) models and tools to load and utilize pre-trained checkpoints, designed to be integrated into deep learning pipelines with PyTorch."
.. currentmodule:: kornia.contrib
Models
------
Base
^^^^
.. autoclass:: kornia.models.base.ModelBase
:members:
:undoc-members:
EfficientViT
^^^^^^^^^^^^
.. autoclass:: kornia.models.efficient_vit.EfficientViT
:members: from_config, forward, load_checkpoint
:undoc-members:
:special-members: __init__,
.. autoclass:: kornia.models.efficient_vit.EfficientViTConfig
:members:
:undoc-members:
Backbones
^^^^^^^^^
.. autoclass:: kornia.models.efficient_vit.backbone.EfficientViTBackbone
:members:
:undoc-members:
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_b0
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_b1
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_b2
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_b3
.. autoclass:: kornia.models.efficient_vit.backbone.EfficientViTLargeBackbone
:members:
:undoc-members:
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_l0
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_l1
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_l2
.. autofunction:: kornia.models.efficient_vit.backbone.efficientvit_backbone_l3
Structures
^^^^^^^^^^
.. _anchor SegmentationResults:
.. autoclass:: kornia.models.structures.SegmentationResults
:members:
:undoc-members:
.. autoclass:: kornia.models.structures.Prompts
:members:
:undoc-members:
VisualPrompter
--------------
.. autoclass:: kornia.contrib.visual_prompter.VisualPrompter
:members: set_image, reset_image, compile, predict, preprocess_image, preprocess_prompts
Edge Detection
--------------
.. autoclass:: EdgeDetector
Face Detection
--------------
.. autoclass:: FaceDetector
.. autoclass:: FaceKeypoint
:members:
:undoc-members:
.. autoclass:: FaceDetectorResult
:members:
:undoc-members:
Interactive Demo
^^^^^^^^^^^^^^^^
.. raw:: html
<gradio-app src="kornia/Face-Detection"></gradio-app>
Visit the `Kornia face detection demo on the Hugging Face Spaces
<https://huggingface.co/spaces/kornia/Face-Detection>`_.
Object Detection
----------------
.. autoclass:: kornia.contrib.object_detection.BoundingBoxDataFormat
:members:
:undoc-members:
:member-order: bysource
.. autoclass:: kornia.contrib.object_detection.BoundingBox
:members:
:undoc-members:
.. autoclass:: kornia.contrib.object_detection.ObjectDetectorResult
:members:
:undoc-members:
.. autoclass:: kornia.contrib.object_detection.ObjectDetector
:members:
:undoc-members:
:special-members: __init__,
.. autoclass:: kornia.contrib.object_detection.ResizePreProcessor
:members:
:undoc-members:
.. autofunction:: kornia.contrib.object_detection.results_from_detections
Real-Time Detection Transformer (RT-DETR)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: kornia.models.rt_detr.RTDETRModelType
:members:
:undoc-members:
:member-order: bysource
.. autoclass:: kornia.models.rt_detr.RTDETRConfig
:members:
:undoc-members:
.. autoclass:: kornia.models.rt_detr.RTDETR
:members: from_config, forward, load_checkpoint
:undoc-members:
:special-members: __init__,
.. autoclass:: kornia.models.rt_detr.DETRPostProcessor
:members:
:undoc-members:
Image Segmentation
------------------
.. autofunction:: connected_components
Segment Anything (SAM)
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: kornia.models.sam.SamModelType
:members:
:undoc-members:
:member-order: bysource
.. autoclass:: kornia.models.sam.SamConfig
:members:
:undoc-members:
.. autoclass:: kornia.models.sam.Sam
:members: from_config, forward, load_checkpoint
:undoc-members:
:special-members: __init__,
Image Patches
-------------
.. autofunction:: compute_padding
.. autofunction:: extract_tensor_patches
.. autofunction:: combine_tensor_patches
.. autoclass:: ExtractTensorPatches
.. autoclass:: CombineTensorPatches
Image Classification
--------------------
.. autoclass:: kornia.models.vit.VisionTransformer
:members:
.. autoclass:: kornia.models.vit_mobile.MobileViT
.. autoclass:: TinyViT
:members:
Image Stitching
---------------
.. autoclass:: ImageStitcher
Lambda
------
.. autoclass:: Lambda
Distance Transform
------------------
.. autofunction:: distance_transform
.. autofunction:: diamond_square
.. autoclass:: DistanceTransform
KMeans
------
.. autoclass:: KMeans
:members: