Visitar URL original
Updates to the docs by n-poulsen · Pull Request #2871 · 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
improvements to maDLC docs
  • Loading branch information
Niels Poulsen
Niels Poulsen committed Feb 10, 2025
commit dac8bf57f7e0c6eba582948092ba5749d1a14fe1
1 change: 1 addition & 0 deletions docs/api/deeplabcut.convert_detections2tracklets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. autofunction:: deeplabcut.compat.convert_detections2tracklets
1 change: 1 addition & 0 deletions docs/api/deeplabcut.stitch_tracklets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. autofunction:: deeplabcut.refine_training_dataset.stitch.stitch_tracklets
44 changes: 44 additions & 0 deletions docs/maDLC_UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,29 @@ deeplabcut.stitch_tracklets(..., n_tracks=n)

In such cases, file columns will default to dummy animal names (ind1, ind2, ..., up to indn).

#### API Docs

````{admonition} Click the button to see API Docs for analyze_videos
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.analyze_videos.rst
```
````

````{admonition} Click the button to see API Docs for convert_detections2tracklets
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.convert_detections2tracklets.rst
```
````

````{admonition} Click the button to see API Docs for stitch_tracklets
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.stitch_tracklets.rst
```
````

### Using Unsupervised Identity Tracking:

In Lauer et al. 2022 we introduced a new method to do unsupervised reID of animals.
Expand Down Expand Up @@ -830,6 +853,13 @@ 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
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.filterpredictions.rst
```
````

### Plotting Results:

- **NOTE :bulb::mega::** Before you create a video, you should set what threshold to use for plotting. This is set in the `config.yaml` file as `pcutoff` - if you have a well trained network, this should be high, i.e. set it to `0.8` or higher! IF YOU FILLED IN GAPS, you need to set this to `0` to "see" the filled in parts.
Expand All @@ -850,6 +880,20 @@ Create videos:

(more details [here](functionDetails.md#i-video-analysis-and-plotting-results))

````{admonition} Click the button to see API Docs for plot_trajectories
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.plot_trajectories.rst
```
````

````{admonition} Click the button to see API Docs for create_labeled_video
:class: dropdown
```{eval-rst}
.. include:: ./api/deeplabcut.create_labeled_video.rst
```
````

### HELP:

In ipython/Jupyter notebook:
Expand Down