Visitar URL original
Add automated docs & notebooks freshness + normalization checks by C-Achard · Pull Request #3228 · DeepLabCut/DeepLabCut · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
7f92330
Add docs & notebooks staleness check tool
C-Achard Mar 5, 2026
5c60b01
Add staleness workflow for docs and notebooks
C-Achard Mar 5, 2026
9080556
Use docs_nb_checks as output directory
C-Achard Mar 5, 2026
eea323e
Make meta_to_jsonable JSON-safe for dates
C-Achard Mar 5, 2026
3484812
Add nbformat and notebook normalization checks
C-Achard Mar 5, 2026
3728e89
Add local pre-commit hook for docs/notebooks
C-Achard Mar 5, 2026
af816c5
Support targeted scans and use repo config path
C-Achard Mar 5, 2026
032d5d3
Update docs/notebooks README paths & cmds
C-Achard Mar 5, 2026
47028b5
Fix arg ordering
C-Achard Mar 5, 2026
e07a38c
Update docs_and_notebooks_check.py
C-Achard Mar 5, 2026
52cdc4a
Apply suggestions from code review
C-Achard Mar 5, 2026
be93a65
Move docs_notebooks tool to tools/
C-Achard Mar 6, 2026
f944212
Merge branch 'main' into cy/automated-docs&nb-report
C-Achard Mar 6, 2026
dfb26f3
Skip metadata commits when computing content date
C-Achard Mar 6, 2026
5227915
Add docs/notebook contract tests; rebuild models
C-Achard Mar 6, 2026
82f963e
Update docs_and_notebooks tool README
C-Achard Mar 6, 2026
dc10a6f
Update docs/notebooks workflow: deps & timeout
C-Achard Mar 6, 2026
b52ccb3
Add pydantic>2 dependency
C-Achard Mar 6, 2026
a7a8f80
Detect missing vs invalid DLC metadata
C-Achard Mar 6, 2026
29f6d24
Add tests for notebook DLC metadata warnings
C-Achard Mar 6, 2026
37a0887
Install dev extras in CI and update dev deps
C-Achard Mar 6, 2026
2e7847f
Add --no-step-summary flag and update summary
C-Achard Mar 6, 2026
feeef82
CI: upgrade checkout and adjust pip install
C-Achard Mar 6, 2026
866d705
Bump CI actions, fix deps and tests formatting
C-Achard Mar 10, 2026
0e76818
Only stamp metadata on write; rename git_stale
C-Achard Mar 10, 2026
336b6ac
Defer stamping last_metadata_updated until write
C-Achard Mar 10, 2026
ca91469
Simplify notebook writes
C-Achard Mar 10, 2026
c57ff21
Specify HEAD and use --fixed-strings in git log
C-Achard Mar 10, 2026
9a58f68
Refactor git date parsing and log helpers
C-Achard Mar 10, 2026
3c70970
Merge branch 'main' into cy/automated-docs&nb-report
C-Achard Mar 10, 2026
5f0a328
Refactor dlc docs/notebooks pre-commit hook
C-Achard Mar 16, 2026
1da0a70
docs: clarify metadata/normalization guidance
C-Achard Mar 16, 2026
f1806a3
Report scan/parsing issues non-fatal; add strict mode
C-Achard Mar 17, 2026
7838d07
Pydantic v2 migration and frontmatter error fixes
C-Achard Mar 17, 2026
5d22716
tests: update for renamed constant and 3-tuple
C-Achard Mar 17, 2026
648c178
Merge branch 'main' into cy/automated-docs&nb-report
C-Achard Mar 17, 2026
8c0dc21
chore(metadata): update docs/notebooks metadata
C-Achard Mar 6, 2026
c2e519d
Populate live-GUI docs
C-Achard Mar 17, 2026
f41946f
Merge pull request #3232 from DeepLabCut/cy/docs-nbs-check-apply
C-Achard Mar 19, 2026
a180893
Merge branch 'main' into cy/automated-docs&nb-report
C-Achard Mar 19, 2026
7675a2d
Update pyproject.toml
C-Achard Mar 19, 2026
9d31fc0
Update uv.lock
C-Achard Mar 20, 2026
e9d509d
Merge remote-tracking branch 'upstream/main' into cy/automated-docs&n…
deruyter92 Mar 20, 2026
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
chore(metadata): update docs/notebooks metadata
  • Loading branch information
C-Achard committed Mar 17, 2026
commit 8c0dc21efdcc7722af261117a8304dd2d330c1c3
6 changes: 6 additions & 0 deletions docs/Governance.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
(governance-model)=
# Governance Model of DeepLabCut
(adapted from https://napari.org/stable/community/governance.html)
Expand Down
6 changes: 6 additions & 0 deletions docs/HelperFunctions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
(helper-functions)=
# Helper & Advanced Optional Function Documentation

Expand Down
6 changes: 6 additions & 0 deletions docs/MISSION_AND_VALUES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
(mission-and-values)=
# Mission and Values of DeepLabCut

Expand Down
6 changes: 6 additions & 0 deletions docs/ModelZoo.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-07-06'
last_metadata_updated: '2026-03-06'
ignore: false
---
(file:model-zoo)=
# The DeepLabCut Model Zoo!

Expand Down
6 changes: 6 additions & 0 deletions docs/Overviewof3D.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-10-14'
last_metadata_updated: '2026-03-06'
ignore: false
---
(3D-overview)=
# 3D DeepLabCut

Expand Down
6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2022-08-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
Please see https://deeplabcut.github.io/DeepLabCut for documentation on how to use this software.

This directory contains the source code for the docs.
6 changes: 6 additions & 0 deletions docs/UseOverviewGuide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
(overview)=
# 🥳 Get started with DeepLabCut: our key recommendations

Expand Down
6 changes: 6 additions & 0 deletions docs/beginner-guides/Training-Evaluation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Neural Network training and evaluation in the GUI
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">

Expand Down
6 changes: 6 additions & 0 deletions docs/beginner-guides/beginners-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-03-03'
last_metadata_updated: '2026-03-06'
ignore: false
---
(beginners-guide)=
# Using DeepLabCut
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
Expand Down
6 changes: 6 additions & 0 deletions docs/beginner-guides/labeling.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
(labeling)=
# Labeling GUI

Expand Down
6 changes: 6 additions & 0 deletions docs/beginner-guides/manage-project.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Setting up what keypoints to track
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">

Expand Down
6 changes: 6 additions & 0 deletions docs/beginner-guides/video-analysis.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Video Analysis with DeepLabCut
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">

Expand Down
6 changes: 6 additions & 0 deletions docs/benchmark.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# DeepLabCut benchmark

For further information and the leaderboard, see [the official homepage](https://benchmark.deeplabcut.org/).
Expand Down
6 changes: 6 additions & 0 deletions docs/citation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2024-10-27'
last_metadata_updated: '2026-03-06'
ignore: false
---
# How to Cite DeepLabCut

Thank you for using DeepLabCut! Here are our recommendations for citing and documenting your use of DeepLabCut in your Methods section:
Expand Down
6 changes: 6 additions & 0 deletions docs/convert_maDLC.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
(convert-maDLC)=
# How to convert a pre-2.2 project for use with DeepLabCut 2.2 or later

Expand Down
6 changes: 6 additions & 0 deletions docs/course.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
# DeepLabCut Self-paced Course

::::{warning}
Expand Down
6 changes: 6 additions & 0 deletions docs/docker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-04-15'
last_metadata_updated: '2026-03-06'
ignore: false
---
(docker-containers)=
# DeepLabCut Docker containers

Expand Down
6 changes: 6 additions & 0 deletions docs/gui/PROJECT_GUI.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
(project-manager-gui)=
# Interactive Project Manager GUI

Expand Down
6 changes: 6 additions & 0 deletions docs/gui/napari_GUI.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
(napari-gui)=
# napari labeling GUI

Expand Down
6 changes: 6 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-23'
last_metadata_updated: '2026-03-06'
ignore: false
---
(how-to-install)=
# How To Install DeepLabCut

Expand Down
6 changes: 6 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
---
deeplabcut:
last_content_updated: '2024-06-14'
last_metadata_updated: '2026-03-06'
ignore: false
---
Please see the main [READ ME!](https://deeplabcut.github.io/DeepLabCut/README.html)
6 changes: 6 additions & 0 deletions docs/maDLC_UserGuide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
(multi-animal-userguide)=
# DeepLabCut for Multi-Animal Projects

Expand Down
6 changes: 6 additions & 0 deletions docs/pytorch/Benchmarking_shuffle_guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
# DeepLabCut Benchmarking - User Guide

## Reasoning for benchmarking models in DLC (across DLC versions and architectures)
Expand Down
6 changes: 6 additions & 0 deletions docs/pytorch/architectures.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
(dlc3-architectures)=
# DeepLabCut 3.0 - PyTorch Model Architectures

Expand Down
6 changes: 6 additions & 0 deletions docs/pytorch/pytorch_config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-10-02'
last_metadata_updated: '2026-03-06'
ignore: false
---
(dlc3-pytorch-config)=
# The PyTorch Configuration file

Expand Down
6 changes: 6 additions & 0 deletions docs/pytorch/user_guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-07-01'
last_metadata_updated: '2026-03-06'
ignore: false
---
(dlc3-user-guide)=
# DeepLabCut 3.0 - PyTorch User Guide

Expand Down
6 changes: 6 additions & 0 deletions docs/pytorch_dlc.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2024-01-17'
last_metadata_updated: '2026-03-06'
ignore: false
---
# DeepLabCut: PyTorch API

## Modules
Expand Down
6 changes: 6 additions & 0 deletions docs/quick-start/single_animal_quick_guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-06-30'
last_metadata_updated: '2026-03-06'
ignore: false
---
# QUICK GUIDE to single Animal Training:
**The main steps to take you from project creation to analyzed videos:**

Expand Down
6 changes: 6 additions & 0 deletions docs/quick-start/tutorial_maDLC.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Multi-animal pose estimation with DeepLabCut: A 5-minute tutorial

## GUI:
Expand Down
7 changes: 6 additions & 1 deletion docs/recipes/BatchProcessing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

---
deeplabcut:
last_content_updated: '2025-09-16'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Automate training and video analysis: Batch Processing

## Tips for working with DLC networks:
Expand Down
7 changes: 6 additions & 1 deletion docs/recipes/ClusteringNapari.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Clustering in the napari-DeepLabCut GUI

To increase model performance, one can find the errors in the user-defined label (or in output H5 files after video
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/DLCMethods.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# How to write a DLC Methods Section

**Pose estimation using DeepLabCut**
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/MegaDetectorDLCLive.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
# 💚 MegaDetector+DeepLabCut 💜

[DeepLabCut-Live](https://github.com/DeepLabCut/DeepLabCut-live) is an open source and free real-time package from DeepLabCut that allows for real-time, low-latency pose estimation. [The DeepLabCut-ModelZoo](http://modelzoo.deeplabcut.org/) is our growing collection of pretrained animal models for rapid deployment; no training is typically required to use these models. MegaDetector is a free open software trained to detect animals, people, and vehicles from camera trap images. Check [here](https://github.com/microsoft/CameraTraps/blob/main/megadetector.md) for further information.
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/OpenVINO.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Intel OpenVINO backend

::::{warning}
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/OtherData.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# How to use data labeled outside of DeepLabCut
- and/or if you merge projects across scorers (see below):

Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/TechHardware.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2026-02-10'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Technical (Hardware) Considerations

## Quick summary:
Expand Down
6 changes: 6 additions & 0 deletions docs/recipes/UsingModelZooPupil.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
deeplabcut:
last_content_updated: '2025-02-28'
last_metadata_updated: '2026-03-06'
ignore: false
---
# Using ModelZoo models on your own datasets

<p style='text-align: justify;'>Animal behavior has to be analyzed with painstaking accuracy. Therefore, animal pose estimation has been
Expand Down
5 changes: 5 additions & 0 deletions docs/recipes/flip_and_rotate.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1867,6 +1867,11 @@
],
"metadata": {
"celltoolbar": "Edit Metadata",
"deeplabcut": {
"ignore": false,
"last_content_updated": "2025-09-16",
"last_metadata_updated": "2026-03-06"
},
"kernelspec": {
"display_name": "Python [conda env:DEEPLABCUT_newGUI] *",
"language": "python",
Expand Down
Loading