forked from DeepLabCut/DeepLabCut
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding a Quick Guide (from the wiki to the docs!) (DeepLabCut#2532)
* Create single_animal_quick_guide.md * Update _toc.yml * Rename docs/tutorial.md to tutorial_maDLC.md
- Loading branch information
1 parent
9f36904
commit 1e172d1
Showing
3 changed files
with
71 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.