Manage Project¶
The first tab of the app is a project manager that allows you to create, load, and delete projects.
Create new project¶
First, enter your project name (at least 3 characters).
After you hit “Enter”, you will be asked to record the number of camera views. Currently, more than one view is only supported if the views are fused into single frames, or a mirror is used to create multiple views from a single camera. In this example we have a side and bottom view of a mouse, so we enter “2”.
Next, you will define the set of keypoints that you would like to label. In the example below we enter four keypoint names: two bodyparts (“nose” and “tailbase”) seen from two views (“top” and “bottom”). If you are using more than one view, we recommend listing all keypoints from one view first, then all keypoints from the next view, etc.
Note
Keypoint names cannot contain spaces or dashes (underscores are ok).
You will then be prompted to select a subset of keypoints for the Pose PCA loss. Including static keypoints (e.g. those marking a corner of an arena) are generally not helpful. Also be careful to not include keypoints that are often occluded, like the tongue. If these keypoints are included the Pose PCA loss will try to localize them even when they are occluded, which might be unhelpful if you want to use the confidence of the outputs as a lick detector.
Finally, if you chose more than one camera view, you will select which keypoints correspond to the same body part from different views. This table will be filled out automatically, but check to make sure it is correct!
Click “Create project”; you will see “Request submitted”. Once the project is created the text will update to “Proceed to the next tab to extract frames for labeling” in green, and a new set of tabs will appear at the top of the app.
Create new project from source¶
Warning
The app currently supports conversion of DLC and SLEAP projects. If you have another type of project that needs conversion support (DPK, MS COCO, etc.) please raise an issue.
DeepLabCut
The standard DLC project directory looks like the following:
<dlc-project>
├── dlc-models/
├── labeled-data/
├── training-datasets/
├── videos/
└── config.yaml
You will need to create a zip file of this project directory to upload to the app.
The upload process can take some time, so we recommend first creating a version of the dlc project
that only contains the directories labeled-data and videos.
Make sure the videos are not symlinks!
Once you have created this project copy, compress it into a zip file.
<dlc-project-copy>
├── labeled-data/
└── videos/
SLEAP
For SLEAP, all you need to do is export your project in the .pkg.slp format.
Next steps
In the Lightning Pose App project manager, select “Create new project from source” and give your project a name (can be the same as the DLC/SLEAP name or different). You will then select the uploaded project format, and upload your zip/slp file.
Note
If your file is larger than the 200MB limit, see the FAQ.
For DLC: you may also replace many large video files with smaller video snippets for faster
uploading.
Whatever video files are in the videos directory will be used for unsupervised losses.
Once the file upload is complete you will need to walk through the steps covered in Create new project (though note the keypoint names are now provided). Once you click “Create project” your project will be successfully converted! If you have many hundreds or thousands of labeled images in your project it may take several minutes to upload all of the data into LabelStudio.
Load existing project¶
Select one of the available projects, and click “Load project”.
You will see the previously entered project data appear (camera views, keypoint names, etc.). You can then navigate to other project tabs.
Delete existing project¶
Select one of the available projects, and click “Delete project”.
Warning
This action will delete your extracted frames, videos, and hand labels from the data directory. This is not a reversible action.
Note
This action will not delete your project from the LabelStudio database. We require you to do this separately to ensure a copy of the data is not accidentally deleted.
To delete the project from the LabelStudio database, you will need to load another project in order to display the other available app tabs. Navigate to the “Label Frames” tab, where you will see a collection of all available LabelStudio projects.
click the three dots on the upper right corner of the project you wish to delete
select “Settings” from the drop-down menu
click “Danger Zone” on the left-hand menu
click “Delete Project” - this is not a reversible action