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
dev docs: move to project root
  • Loading branch information
deruyter92 committed Jul 16, 2026
commit 5969efac0c03a9714cf731a87be8f23e5623ab2d
4 changes: 2 additions & 2 deletions .github/workflows/publish-book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ jobs:

- name: Build developer docs
run: |
mkdocs build -v -f deeplabcut/pose_estimation_pytorch/mkdocs.yml --site-dir site
mkdocs build -v -f dev-docs/mkdocs.yml

- name: Upload developer docs artifact
uses: actions/upload-artifact@v6
with:
name: built-dev-docs
path: site
path: _build/dev
if-no-files-found: error
retention-days: 1

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ resume_training_from: /path/to/model/train/snapshot-010.pt

- Inference Configuration: configure inference-specific behavior independently of training:

- Top-Down Detector Configuration: Top-down models require a separate detector configuration:
- Top-Down Detector Configuration: Top-down models require a separate detector configuration:
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ The registry system allows you to register custom components that can be instant
- [`NECKS`][deeplabcut.pose_estimation_pytorch.models.necks] - Intermediate processing layers
- [`HEADS`][deeplabcut.pose_estimation_pytorch.models.heads] - Task-specific output layers
- [`PREDICTORS`][deeplabcut.pose_estimation_pytorch.models.predictors] - Output-to-keypoint converters
- [`TARGET_GENERATORS`][deeplabcut.pose_estimation_pytorch.models.target_generators] - Annotation-to-target converters
- [`TARGET_GENERATORS`][deeplabcut.pose_estimation_pytorch.models.target_generators] - Annotation-to-target converters
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ class MyBackbone(BaseBackbone):
def __init__(self, ...):
super().__init__(stride=32)
# Implementation

def forward(self, x):
# Forward pass
return x
Expand Down Expand Up @@ -178,4 +178,4 @@ Runners encapsulate training and inference logic:
- [`PoseInferenceRunner`][deeplabcut.pose_estimation_pytorch.runners.PoseInferenceRunner]: Handles pose estimation
- [`DetectorInferenceRunner`][deeplabcut.pose_estimation_pytorch.runners.DetectorInferenceRunner]: Handles object detection

Runners can be created from configuration or instantiated directly for custom workflows.
Runners can be created from configuration or instantiated directly for custom workflows.
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,3 @@ pose_runner = dlc_torch.get_pose_inference_runner(
# as a dict (with keys for "bodyparts" but also "bboxes")!
predictions = pose_runner.inference(images=tqdm(video))
```

File renamed without changes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend not adding this, I think contribution guides cover dev installation well enough.
pre-commit usage and config, CI workflows, etc, would be better topics IMO

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed. Let's keep it in the main docs only

Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# Installation

Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ All predictors inherit from [`BasePredictor`][deeplabcut.pose_estimation_pytorch

Target generators create training targets from ground truth annotations. The [`deeplabcut.pose_estimation_pytorch.models.target_generators`][] module provides generators for different output types.

All target generators inherit from [`BaseGenerator`][deeplabcut.pose_estimation_pytorch.models.target_generators.BaseGenerator].
All target generators inherit from [`BaseGenerator`][deeplabcut.pose_estimation_pytorch.models.target_generators.BaseGenerator].
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ print(models)
detectors = available_detectors()
print(detectors)
# Output: ['fasterrcnn_resnet50_fpn', 'fasterrcnn_mobilenet_v3_large_fpn', 'yolox_s', ...]
```
```
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
site_name: DeepLabCut Developer Documentation
site_description: Developer documentation for DeepLabCut
site_url: https://deeplabcut.github.io/DeepLabCut/dev
site_dir: "../_build/dev"

repo_name: DeepLabCut/DeepLabCut
repo_url: https://github.com/DeepLabCut/DeepLabCut

theme:
name: material
custom_dir: "docs/theme"
logo: assets/logo.png
favicon: assets/favicon.ico
logo: docs/assets/logo.png
favicon: docs/assets/favicon.ico

palette:
- media: "(prefers-color-scheme: light)"
Expand Down Expand Up @@ -50,9 +51,14 @@ plugins:
- mike # for versioning
- mkdocs-jupyter # adds support for rendering Jupyter Notebooks
- api-autonav: # automatically generates API reference navigation based on the file structure
modules: ["../"]
modules:
- "../deeplabcut"
module_options: {}
exclude: []
exclude:
- "deeplabcut.version"
- "deeplabcut.cli"
- "deeplabcut.benchmark"
- "deeplabcut.gui"
nav_section_title: "API Reference"
api_root_uri: "reference"
nav_item_prefix: "<code class='doc-symbol doc-symbol-nav doc-symbol-module'></code>"
Expand All @@ -63,6 +69,7 @@ plugins:
default_handler: python
handlers:
python:
paths: [".."] # repo root, so `import deeplabcut` resolves correctly
options:
summary: true
show_root_heading: true
Expand Down