Skip to content

Adding a Quick Guide (from the wiki to the docs!) #2532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MMathisLab merged 3 commits into from
Mar 5, 2024
Merged

Adding a Quick Guide (from the wiki to the docs!) #2532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ae0d9f
Create single_animal_quick_guide.md
MMathisLab Mar 1, 2024
b2809bc
Update _toc.yml
MMathisLab Mar 1, 2024
f6796c8
Rename docs/tutorial.md to tutorial_maDLC.md
MMathisLab Mar 1, 2024
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
5 changes: 3 additions & 2 deletions _toc.yml
View file
Open in desktop
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
View file
Open in desktop
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)
```
0 docs/tutorial.md → tutorial_maDLC.md
View file
Open in desktop
File renamed without changes.