Skip to content

Commit

Permalink
Adding a Quick Guide (from the wiki to the docs!) (DeepLabCut#2532)
Browse files Browse the repository at this point in the history
* Create single_animal_quick_guide.md

* Update _toc.yml

* Rename docs/tutorial.md to tutorial_maDLC.md
  • Loading branch information
MMathisLab authored Mar 5, 2024
1 parent 9f36904 commit 1e172d1
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 2 deletions.
5 changes: 3 additions & 2 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ parts:
chapters:
- file: docs/PROJECT_GUI
- file: docs/napari_GUI
- caption: Tutorials
- caption: Quick Start Tutorials
chapters:
- file: docs/tutorial
- file: docs/single_animal_quick_guide
- file: docs/tutorial_maDLC
- caption: Hardware Tips
chapters:
- file: docs/recipes/TechHardware
Expand Down
68 changes: 68 additions & 0 deletions docs/single_animal_quick_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
### QUICK GUIDE to single Animal Training:
**The main steps to take you from project creation to analyzed videos:**

Open ipython in the terminal:
```
ipython
import deeplabcut
```

Create a new project:
```
deeplabcut.create_new_project(‘project_name’,‘experimenter’,[‘path of video 1’,‘path of video2’,..])
```

Set a config_path variable for ease of use + go edit this file!:
```
config_path = ‘yourdirectory/project_name/config.yaml’
```
Extract frames:
```
deeplabcut.extract_frames(config_path)
```

Label frames:
```
deeplabcut.label_frames(config_path)
```

Check labels [OPTIONAL]:
```
deeplabcut.check_labels(config_path)
```

Create training dataset:
```
deeplabcut.create_training_dataset(config_path)
```

Train the network:
```
deeplabcut.train_network(config_path)
```

Evaluate the trained network:
```
deeplabcut.evaluate_network(config_path)
```

Video analysis:
```
deeplabcut.analyze_videos(config_path, [‘path of video 1’,‘path of video2’, ...])
```

Filter predictions [OPTIONAL]:
```
deeplabcut.filterpredictions(config_path, [‘path of video 1’,‘path of video2’,..])
```

Plot results (trajectories):
```
deeplabcut.plot_trajectories(config_path, [‘path of video 1’,‘path of video2’,..], filtered=True)
```

Create a video:
```
deeplabcut.create_labeled_video(config_path, [‘path of video 1’,‘path of video2’,..]filtered=True)
```
File renamed without changes.

0 comments on commit 1e172d1

Please sign in to comment.