Visitar URL original
Docs audit [April 2026]: Add dev docs by deruyter92 · Pull Request #3336 · DeepLabCut/DeepLabCut · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add stub files for dev documentation
  • Loading branch information
arashsm79 authored and deruyter92 committed Jul 16, 2026
commit bc3072d26529aa3010ea708935cd73bf8ccde0df
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Model Configuration
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/custom_models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Adding Custom Models
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/dataprep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Data Preparation and Loading
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/devguides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Developer Guides
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Code Examples
19 changes: 19 additions & 0 deletions deeplabcut/pose_estimation_pytorch/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DeepLabCut PyTorch API Documentation

<div align="center">

<p align="center">
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1628250004229-KVYD7JJVHYEFDJ32L9VJ/DLClogo2021.jpg?format=1000w" width="95%">
</p>

</div>

[![PyPI](https://img.shields.io/pypi/v/deeplabcut?label=PyPI)](https://pypi.org/project/deeplabcut)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deeplabcut)
[![License](https://img.shields.io/github/license/DeepLabCut/DeepLabCut)](https://github.com/DeepLabCut/DeepLabCut/blob/main/LICENSE)

This documentation is designed for maintainers, developers, and expert users who want to understand and extend the PyTorch backend of DeepLabCut 3.0+. It provides detailed information about the architecture, APIs, and practical examples for building and training state-of-the-art pose estimation models.

## Overview

The [`deeplabcut.pose_estimation_pytorch`][] package provides a complete framework for training and deploying deep learning models for pose estimation. The API is designed to be modular, flexible, and extensible, allowing developers to easily add new models, customize training pipelines, and integrate with existing workflows.
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/inference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Inference and Video Analysis
2 changes: 2 additions & 0 deletions deeplabcut/pose_estimation_pytorch/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Installation

1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Model Architecture
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Quick Start
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tracking Guide
1 change: 1 addition & 0 deletions deeplabcut/pose_estimation_pytorch/docs/training.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Training Models