mmpose-0.29.0/docs/en/api.rst

mmpose.apis
-------------
.. automodule:: mmpose.apis
 :members:


mmpose.apis.webcam
--------------------
.. contents:: MMPose Webcam API: Tools to build simple interactive webcam applications and demos
 :depth: 2
 :local:
 :backlinks: top

Executor
^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: mmpose.apis.webcam
.. autosummary::
 :toctree: generated
 :nosignatures:

 WebcamExecutor

Nodes
^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: mmpose.apis.webcam.nodes

Base Nodes
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:
 :template: webcam_node_class.rst

 Node
 BaseVisualizerNode

Model Nodes
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:
 :template: webcam_node_class.rst

 DetectorNode
 TopDownPoseEstimatorNode
 PoseTrackerNode

Visualizer Nodes
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:
 :template: webcam_node_class.rst

 ObjectVisualizerNode
 NoticeBoardNode
 SunglassesEffectNode
 BigeyeEffectNode

Helper Nodes
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:
 :template: webcam_node_class.rst

 ObjectAssignerNode
 MonitorNode
 RecorderNode

Utils
^^^^^^^^^^^^^^^^^^^^
.. currentmodule:: mmpose.apis.webcam.utils

Buffer and Message
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:

 BufferManager
 Message
 FrameMessage
 VideoEndingMessage

Pose
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:

 get_eye_keypoint_ids
 get_face_keypoint_ids
 get_hand_keypoint_ids
 get_mouth_keypoint_ids
 get_wrist_keypoint_ids

Event
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:

 EventManager

Misc
""""""""""""""""""""
.. autosummary::
 :toctree: generated
 :nosignatures:

 copy_and_paste
 screen_matting
 expand_and_clamp
 limit_max_fps
 is_image_file
 get_cached_file_path
 load_image_from_disk_or_url
 get_config_path

mmpose.core
-------------
evaluation
^^^^^^^^^^^
.. automodule:: mmpose.core.evaluation
 :members:

fp16
^^^^^^^^^^^
.. automodule:: mmpose.core.fp16
 :members:


utils
^^^^^^^^^^^
.. automodule:: mmpose.core.utils
 :members:


post_processing
^^^^^^^^^^^^^^^^
.. automodule:: mmpose.core.post_processing
 :members:


mmpose.models
---------------
backbones
^^^^^^^^^^^
.. automodule:: mmpose.models.backbones
 :members:

necks
^^^^^^^^^^^
.. automodule:: mmpose.models.necks
 :members:

detectors
^^^^^^^^^^^
.. automodule:: mmpose.models.detectors
 :members:

heads
^^^^^^^^^^^^^^^
.. automodule:: mmpose.models.heads
 :members:

losses
^^^^^^^^^^^
.. automodule:: mmpose.models.losses
 :members:

misc
^^^^^^^^^^^
.. automodule:: mmpose.models.misc
 :members:

mmpose.datasets
-----------------
.. automodule:: mmpose.datasets
 :members:

datasets
^^^^^^^^^^^
.. automodule:: mmpose.datasets.datasets.top_down
 :members:
 :noindex:

.. automodule:: mmpose.datasets.datasets.bottom_up
 :members:
 :noindex:

pipelines
^^^^^^^^^^^
.. automodule:: mmpose.datasets.pipelines
 :members:

.. automodule:: mmpose.datasets.pipelines.loading
 :members:

.. automodule:: mmpose.datasets.pipelines.shared_transform
 :members:

.. automodule:: mmpose.datasets.pipelines.top_down_transform
 :members:

.. automodule:: mmpose.datasets.pipelines.bottom_up_transform
 :members:

.. automodule:: mmpose.datasets.pipelines.mesh_transform
 :members:

.. automodule:: mmpose.datasets.pipelines.pose3d_transform
 :members:

samplers
^^^^^^^^^^^
.. automodule:: mmpose.datasets.samplers
 :members:
 :noindex:

mmpose.utils
---------------
.. automodule:: mmpose.utils
 :members: