From ace4eed8a83bd587040e6b3679fd6bf060f28718 Mon Sep 17 00:00:00 2001 From: Jaap de Ruyter Date: Wed, 12 Aug 2026 16:33:38 +0200 Subject: [PATCH] remove RST api docs references - replace with links to API docs --- docs/api/deeplabcut.analyze_videos.rst | 1 - docs/api/deeplabcut.analyzeskeleton.rst | 1 - docs/api/deeplabcut.check_labels.rst | 1 - ...eeplabcut.convert_detections2tracklets.rst | 1 - docs/api/deeplabcut.create_labeled_video.rst | 1 - docs/api/deeplabcut.create_new_project.rst | 1 - .../deeplabcut.create_training_dataset.rst | 1 - ...e_training_dataset_from_existing_split.rst | 1 - ...abcut.create_training_model_comparison.rst | 1 - docs/api/deeplabcut.evaluate_network.rst | 1 - docs/api/deeplabcut.extract_frames.rst | 1 - .../api/deeplabcut.extract_outlier_frames.rst | 1 - docs/api/deeplabcut.filterpredictions.rst | 1 - docs/api/deeplabcut.label_frames.rst | 1 - docs/api/deeplabcut.merge_datasets.rst | 1 - docs/api/deeplabcut.plot_trajectories.rst | 1 - docs/api/deeplabcut.refine_labels.rst | 1 - docs/api/deeplabcut.stitch_tracklets.rst | 1 - docs/api/deeplabcut.train_network.rst | 1 - ...deeplabcut.video_inference_superanimal.rst | 1 - docs/maDLC_UserGuide.md | 102 ++++++------------ docs/main-workflows/multi-animal-tracking.md | 18 ++-- docs/standardDeepLabCut_UserGuide.md | 96 ++++++----------- 23 files changed, 72 insertions(+), 164 deletions(-) delete mode 100644 docs/api/deeplabcut.analyze_videos.rst delete mode 100644 docs/api/deeplabcut.analyzeskeleton.rst delete mode 100644 docs/api/deeplabcut.check_labels.rst delete mode 100644 docs/api/deeplabcut.convert_detections2tracklets.rst delete mode 100644 docs/api/deeplabcut.create_labeled_video.rst delete mode 100644 docs/api/deeplabcut.create_new_project.rst delete mode 100644 docs/api/deeplabcut.create_training_dataset.rst delete mode 100644 docs/api/deeplabcut.create_training_dataset_from_existing_split.rst delete mode 100644 docs/api/deeplabcut.create_training_model_comparison.rst delete mode 100644 docs/api/deeplabcut.evaluate_network.rst delete mode 100644 docs/api/deeplabcut.extract_frames.rst delete mode 100644 docs/api/deeplabcut.extract_outlier_frames.rst delete mode 100644 docs/api/deeplabcut.filterpredictions.rst delete mode 100644 docs/api/deeplabcut.label_frames.rst delete mode 100644 docs/api/deeplabcut.merge_datasets.rst delete mode 100644 docs/api/deeplabcut.plot_trajectories.rst delete mode 100644 docs/api/deeplabcut.refine_labels.rst delete mode 100644 docs/api/deeplabcut.stitch_tracklets.rst delete mode 100644 docs/api/deeplabcut.train_network.rst delete mode 100644 docs/api/deeplabcut.video_inference_superanimal.rst diff --git a/docs/api/deeplabcut.analyze_videos.rst b/docs/api/deeplabcut.analyze_videos.rst deleted file mode 100644 index f81222169b..0000000000 --- a/docs/api/deeplabcut.analyze_videos.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.analyze_videos diff --git a/docs/api/deeplabcut.analyzeskeleton.rst b/docs/api/deeplabcut.analyzeskeleton.rst deleted file mode 100644 index 0f4d402bec..0000000000 --- a/docs/api/deeplabcut.analyzeskeleton.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.post_processing.analyze_skeleton.analyzeskeleton diff --git a/docs/api/deeplabcut.check_labels.rst b/docs/api/deeplabcut.check_labels.rst deleted file mode 100644 index e9d2f1e349..0000000000 --- a/docs/api/deeplabcut.check_labels.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.generate_training_dataset.trainingsetmanipulation.check_labels diff --git a/docs/api/deeplabcut.convert_detections2tracklets.rst b/docs/api/deeplabcut.convert_detections2tracklets.rst deleted file mode 100644 index 6d20627965..0000000000 --- a/docs/api/deeplabcut.convert_detections2tracklets.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.convert_detections2tracklets diff --git a/docs/api/deeplabcut.create_labeled_video.rst b/docs/api/deeplabcut.create_labeled_video.rst deleted file mode 100644 index 6b1a92433a..0000000000 --- a/docs/api/deeplabcut.create_labeled_video.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.utils.make_labeled_video.create_labeled_video diff --git a/docs/api/deeplabcut.create_new_project.rst b/docs/api/deeplabcut.create_new_project.rst deleted file mode 100644 index 4536886c6a..0000000000 --- a/docs/api/deeplabcut.create_new_project.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.create_project.new.create_new_project diff --git a/docs/api/deeplabcut.create_training_dataset.rst b/docs/api/deeplabcut.create_training_dataset.rst deleted file mode 100644 index fc728bb8f4..0000000000 --- a/docs/api/deeplabcut.create_training_dataset.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset diff --git a/docs/api/deeplabcut.create_training_dataset_from_existing_split.rst b/docs/api/deeplabcut.create_training_dataset_from_existing_split.rst deleted file mode 100644 index 0b59472d91..0000000000 --- a/docs/api/deeplabcut.create_training_dataset_from_existing_split.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset_from_existing_split diff --git a/docs/api/deeplabcut.create_training_model_comparison.rst b/docs/api/deeplabcut.create_training_model_comparison.rst deleted file mode 100644 index 655c0079a8..0000000000 --- a/docs/api/deeplabcut.create_training_model_comparison.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_model_comparison diff --git a/docs/api/deeplabcut.evaluate_network.rst b/docs/api/deeplabcut.evaluate_network.rst deleted file mode 100644 index f47377f36e..0000000000 --- a/docs/api/deeplabcut.evaluate_network.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.evaluate_network diff --git a/docs/api/deeplabcut.extract_frames.rst b/docs/api/deeplabcut.extract_frames.rst deleted file mode 100644 index 8cb8d4c7d6..0000000000 --- a/docs/api/deeplabcut.extract_frames.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.generate_training_dataset.frame_extraction.extract_frames diff --git a/docs/api/deeplabcut.extract_outlier_frames.rst b/docs/api/deeplabcut.extract_outlier_frames.rst deleted file mode 100644 index cb3ea7718d..0000000000 --- a/docs/api/deeplabcut.extract_outlier_frames.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.refine_training_dataset.outlier_frames.extract_outlier_frames diff --git a/docs/api/deeplabcut.filterpredictions.rst b/docs/api/deeplabcut.filterpredictions.rst deleted file mode 100644 index b383ca1772..0000000000 --- a/docs/api/deeplabcut.filterpredictions.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.post_processing.filtering.filterpredictions diff --git a/docs/api/deeplabcut.label_frames.rst b/docs/api/deeplabcut.label_frames.rst deleted file mode 100644 index 4de3a1054c..0000000000 --- a/docs/api/deeplabcut.label_frames.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.gui.tabs.label_frames.label_frames diff --git a/docs/api/deeplabcut.merge_datasets.rst b/docs/api/deeplabcut.merge_datasets.rst deleted file mode 100644 index 16967dc8a0..0000000000 --- a/docs/api/deeplabcut.merge_datasets.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.refine_training_dataset.outlier_frames.merge_datasets diff --git a/docs/api/deeplabcut.plot_trajectories.rst b/docs/api/deeplabcut.plot_trajectories.rst deleted file mode 100644 index ffa662d8c5..0000000000 --- a/docs/api/deeplabcut.plot_trajectories.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.utils.plotting.plot_trajectories diff --git a/docs/api/deeplabcut.refine_labels.rst b/docs/api/deeplabcut.refine_labels.rst deleted file mode 100644 index b54b640e46..0000000000 --- a/docs/api/deeplabcut.refine_labels.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.gui.tabs.label_frames.refine_labels diff --git a/docs/api/deeplabcut.stitch_tracklets.rst b/docs/api/deeplabcut.stitch_tracklets.rst deleted file mode 100644 index 96677d31a9..0000000000 --- a/docs/api/deeplabcut.stitch_tracklets.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.refine_training_dataset.stitch.stitch_tracklets diff --git a/docs/api/deeplabcut.train_network.rst b/docs/api/deeplabcut.train_network.rst deleted file mode 100644 index d3ee943151..0000000000 --- a/docs/api/deeplabcut.train_network.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.train_network diff --git a/docs/api/deeplabcut.video_inference_superanimal.rst b/docs/api/deeplabcut.video_inference_superanimal.rst deleted file mode 100644 index 442d0d97f9..0000000000 --- a/docs/api/deeplabcut.video_inference_superanimal.rst +++ /dev/null @@ -1 +0,0 @@ -.. autofunction:: deeplabcut.video_inference_superanimal diff --git a/docs/maDLC_UserGuide.md b/docs/maDLC_UserGuide.md index 0ce799554f..5f65b38ac8 100644 --- a/docs/maDLC_UserGuide.md +++ b/docs/maDLC_UserGuide.md @@ -170,14 +170,12 @@ alt: Box 1 — multi-animal project configuration file parameter glossary ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_new_project.rst +[View the `create_new_project` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/create_project/new/#deeplabcut.create_project.new.create_new_project) ``` -```` #### (B) Configure the Project @@ -314,14 +312,12 @@ The user can also look at the extracted frames and e.g. delete frames (from the directory) that are too similar before reloading the set and then manually annotating them. --> -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.extract_frames.rst +[View the `extract_frames` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/frame_extraction/#deeplabcut.generate_training_dataset.frame_extraction.extract_frames) ``` -```` #### (D) Label Frames @@ -409,14 +405,12 @@ Example `check_labels` output with annotations shown per individual. For each video directory in labeled-data this function creates a subdirectory with **labeled** as a suffix. Those directories contain the frames plotted with the annotated body parts. The user can double check if the body parts are labeled correctly. If they are not correct, the user can reload the frames (i.e. `deeplabcut.label_frames`), move them around, and click save again. -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.check_labels.rst +[View the `check_labels` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.check_labels) ``` -```` ### Phase 3 — Training and evaluation @@ -508,32 +502,26 @@ deeplabcut.create_training_dataset_from_existing_split( ``` ```` -````{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset +```{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_dataset.rst +[View the `create_training_dataset` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset) ``` -```` -````{admonition} Click the button to see API Docs for deeplabcut.create_training_model_comparison +```{admonition} Click the button to see API Docs for deeplabcut.create_training_model_comparison --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_model_comparison.rst +[View the `create_training_model_comparison` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_model_comparison) ``` -```` -````{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset_from_existing_split +```{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset_from_existing_split --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_dataset_from_existing_split.rst +[View the `create_training_dataset_from_existing_split` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset_from_existing_split) ``` -```` #### (G) Train The Network @@ -647,14 +635,12 @@ time is correspondingly shorter. ``` ```` -````{admonition} Click the button to see API Docs for train_network +```{admonition} Click the button to see API Docs for train_network --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.train_network.rst +[View the `train_network` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.train_network) ``` -```` #### (H) Evaluate the Trained Network @@ -765,14 +751,12 @@ and the points of interest are labeled accurately • consider labeling additional images and make another iteration of the training data set -````{admonition} Click the button to see API Docs for evaluate_network +```{admonition} Click the button to see API Docs for evaluate_network --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.evaluate_network.rst +[View the `evaluate_network` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.evaluate_network) ``` -```` **maDeepLabCut: (or on normal projects!)** @@ -956,32 +940,26 @@ In such cases, file columns will default to dummy animal names (ind1, ind2, ..., ##### API Docs -````{admonition} Click the button to see API Docs for analyze_videos +```{admonition} Click the button to see API Docs for analyze_videos --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.analyze_videos.rst +[View the `analyze_videos` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.analyze_videos) ``` -```` -````{admonition} Click the button to see API Docs for convert_detections2tracklets +```{admonition} Click the button to see API Docs for convert_detections2tracklets --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.convert_detections2tracklets.rst +[View the `convert_detections2tracklets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.convert_detections2tracklets) ``` -```` -````{admonition} Click the button to see API Docs for stitch_tracklets +```{admonition} Click the button to see API Docs for stitch_tracklets --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.stitch_tracklets.rst +[View the `stitch_tracklets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.stitch_tracklets) ``` -```` ##### Using Unsupervised Identity Tracking: @@ -1045,14 +1023,12 @@ deeplabcut.filterpredictions(config_path,['/fullpath/project/videos/reachingvide Note, this creates a file with the ending filtered.h5 that you can use for further analysis. This filtering step has many parameters, so please see the full docstring by typing: `deeplabcut.filterpredictions?` -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.filterpredictions.rst +[View the `filterpredictions` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/post_processing/#deeplabcut.api.post_processing.filterpredictions) ``` -```` #### (K) Plot Trajectories @@ -1067,14 +1043,12 @@ You can determine a good `pcutoff` value by inspecting the likelihood plot produ deeplabcut.plot_trajectories(config_path, ['/fullpath/project/videos/reachingvideo1.avi'], filtered=True) ``` -````{admonition} Click the button to see API Docs for plot_trajectories +```{admonition} Click the button to see API Docs for plot_trajectories --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.plot_trajectories.rst +[View the `plot_trajectories` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/utils/plotting/#deeplabcut.utils.plotting.plot_trajectories) ``` -```` #### (L) Create Labeled Videos @@ -1092,14 +1066,12 @@ deeplabcut.create_labeled_video( ) ``` -````{admonition} Click the button to see API Docs for create_labeled_video +```{admonition} Click the button to see API Docs for create_labeled_video --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_labeled_video.rst +[View the `create_labeled_video` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/utils/make_labeled_video/#deeplabcut.utils.make_labeled_video.create_labeled_video) ``` -```` ### Phase 5 — Refinement (optional) @@ -1171,14 +1143,12 @@ Once enough outlier frames are extracted the refinement GUI can be used to adjus ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.extract_outlier_frames.rst +[View the `extract_outlier_frames` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.extract_outlier_frames) ``` -```` ______________________________________________________________________ @@ -1238,25 +1208,21 @@ more data. ##### API Docs for deeplabcut.refine_labels -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.refine_labels.rst +[View the `refine_labels` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/cli/#deeplabcut.cli.refine_labels) ``` -```` ##### API Docs for deeplabcut.merge_datasets -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.merge_datasets.rst +[View the `merge_datasets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.merge_datasets) ``` -```` ## Resources and further reading diff --git a/docs/main-workflows/multi-animal-tracking.md b/docs/main-workflows/multi-animal-tracking.md index 8e638c3768..ab116792d7 100644 --- a/docs/main-workflows/multi-animal-tracking.md +++ b/docs/main-workflows/multi-animal-tracking.md @@ -151,32 +151,26 @@ In such cases, file columns will default to dummy animal names (ind1, ind2, ..., ##### API Docs -````{admonition} Click the button to see API Docs for analyze_videos +```{admonition} Click the button to see API Docs for analyze_videos --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.analyze_videos.rst +[View the `analyze_videos` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.analyze_videos) ``` -```` -````{admonition} Click the button to see API Docs for convert_detections2tracklets +```{admonition} Click the button to see API Docs for convert_detections2tracklets --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.convert_detections2tracklets.rst +[View the `convert_detections2tracklets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.convert_detections2tracklets) ``` -```` -````{admonition} Click the button to see API Docs for stitch_tracklets +```{admonition} Click the button to see API Docs for stitch_tracklets --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.stitch_tracklets.rst +[View the `stitch_tracklets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.stitch_tracklets) ``` -```` ##### Using Unsupervised Identity Tracking: diff --git a/docs/standardDeepLabCut_UserGuide.md b/docs/standardDeepLabCut_UserGuide.md index 105681eaa7..a364e2c8a8 100644 --- a/docs/standardDeepLabCut_UserGuide.md +++ b/docs/standardDeepLabCut_UserGuide.md @@ -234,14 +234,12 @@ Single Animal project configuration file glossary ###### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_new_project.rst +[View the `create_new_project` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/create_project/new/#deeplabcut.create_project.new.create_new_project) ``` -```` #### (B) Configure the Project @@ -370,14 +368,12 @@ Manual frame selection using the `extract_frames` GUI. ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.extract_frames.rst +[View the `extract_frames` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/frame_extraction/#deeplabcut.generate_training_dataset.frame_extraction.extract_frames) ``` -```` ______________________________________________________________________ @@ -450,14 +446,12 @@ around, and click save again. ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.check_labels.rst +[View the `check_labels` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.check_labels) ``` -```` ______________________________________________________________________ @@ -584,32 +578,26 @@ deeplabcut.create_training_dataset_from_existing_split( ##### API Docs -````{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset +```{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_dataset.rst +[View the `create_training_dataset` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset) ``` -```` -````{admonition} Click the button to see API Docs for deeplabcut.create_training_model_comparison +```{admonition} Click the button to see API Docs for deeplabcut.create_training_model_comparison --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_model_comparison.rst +[View the `create_training_model_comparison` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_model_comparison) ``` -```` -````{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset_from_existing_split +```{admonition} Click the button to see API Docs for deeplabcut.create_training_dataset_from_existing_split --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_training_dataset_from_existing_split.rst +[View the `create_training_dataset_from_existing_split` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/generate_training_dataset/trainingsetmanipulation/#deeplabcut.generate_training_dataset.trainingsetmanipulation.create_training_dataset_from_existing_split) ``` -```` ______________________________________________________________________ @@ -736,14 +724,12 @@ Single-animal TensorFlow configuration file glossary ##### API Docs -````{admonition} Click the button to see API Docs for train_network +```{admonition} Click the button to see API Docs for train_network --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.train_network.rst +[View the `train_network` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.train_network) ``` -```` ______________________________________________________________________ @@ -833,14 +819,12 @@ you can drop `Indices` to run this on all training/testing images (this is slow! ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.evaluate_network.rst +[View the `evaluate_network` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.evaluate_network) ``` -```` ______________________________________________________________________ @@ -893,14 +877,12 @@ you wish to write to. ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.analyze_videos.rst +[View the `analyze_videos` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/pose_estimation/#deeplabcut.api.pose_estimation.analyze_videos) ``` -```` ##### Novel Video Analysis: extra features @@ -988,14 +970,12 @@ Example output of `filterpredictions` applied to a video. ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.filterpredictions.rst +[View the `filterpredictions` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/post_processing/#deeplabcut.api.post_processing.filterpredictions) ``` -```` ______________________________________________________________________ @@ -1044,14 +1024,12 @@ Example `plot_trajectories` output: body part coordinates, likelihoods, and cons ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.plot_trajectories.rst +[View the `plot_trajectories` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/utils/plotting/#deeplabcut.utils.plotting.plot_trajectories) ``` -```` ______________________________________________________________________ @@ -1163,14 +1141,12 @@ This function has various other parameters, in particular the user can set the ` ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.create_labeled_video.rst +[View the `create_labeled_video` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/utils/make_labeled_video/#deeplabcut.utils.make_labeled_video.create_labeled_video) ``` -```` ##### Extract "Skeleton" Features @@ -1196,14 +1172,12 @@ deeplabcut.analyzeskeleton( ###### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.analyzeskeleton.rst +[View the `analyzeskeleton` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/post_processing/#deeplabcut.api.post_processing.analyzeskeleton) ``` -```` ______________________________________________________________________ @@ -1279,14 +1253,12 @@ Once enough outlier frames are extracted the refinement GUI can be used to adjus ##### API Docs -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.extract_outlier_frames.rst +[View the `extract_outlier_frames` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.extract_outlier_frames) ``` -```` ______________________________________________________________________ @@ -1346,25 +1318,21 @@ more data. ##### API Docs for deeplabcut.refine_labels -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.refine_labels.rst +[View the `refine_labels` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/cli/#deeplabcut.cli.refine_labels) ``` -```` ##### API Docs for deeplabcut.merge_datasets -````{admonition} Click the button to see API Docs +```{admonition} Click the button to see API Docs --- class: dropdown --- -```{eval-rst} -.. include:: ./api/deeplabcut.merge_datasets.rst +[View the `merge_datasets` API documentation](https://deeplabcut.github.io/DeepLabCut/dev/latest-release/reference/deeplabcut/api/refine_training/#deeplabcut.api.refine_training.merge_datasets) ``` -```` ______________________________________________________________________