DIPLOMAT Commands

DIPLOMAT supports the following list of subcommands when running it’s CLI.

Tracking and Analysis Commands

`diplomat track`	Run DIPLOMAT tracking on videos and/or frame stores. Automatically select a frontend based on the passed arguments.
`diplomat supervised`	Run diplomat in supervised mode on the specified config and videos or frame stores. An alias for DIPLOMAT track with the SupervisedSegmentedFramePassEngine predictor.
`diplomat unsupervised`	Run diplomat in unsupervised mode on the specified config and videos or frame stores. An alias for DIPLOMAT track with the SegmentedFramePassEngine predictor.
`diplomat annotate`	Have diplomat annotate, or label a video given it has already been tracked. Automatically searches for the correct frontend to do labeling based on the passed config argument.
`diplomat split_videos`	Split a video into even length segments. This will produce a list of videos with “-part{number}” appended to the original video name in the same directory as the original video.
`diplomat tweak`	Make modifications to DIPLOMAT produced tracking results created for a video using a limited version supervised labeling UI. Allows for touching up and fixing any minor issues that may arise after tracking and saving results.
`diplomat yaml`	Run DIPLOMAT based on a passed yaml run script. The yaml script should include a ‘command’ key specifying the DIPLOMAT sub-command to run and an ‘arguments’ key specifying the list of arguments (key-value pairs) to pass to the command.
`diplomat convert`	Convert DIPLOMAT produced tracking results created for a video from the software specific format to a CSV file for inspection and analysis.

Development Commands

`diplomat predictors list`	Retrieve and print all currently installed and available predictor plugins that can be used with deeplabcut to the console…
`diplomat predictors test`	Run the tests for a predictor plugin.
`diplomat predictors list_settings`	Gets the available/modifiable settings for a specified predictor plugin.
`diplomat frontends list all`	List all frontends currently included with this version of DIPLOMAT.
`diplomat frontends list loaded`	List frontends that have successfully loaded, and list their supported functions.

Frontend Specific Commands (Advanced)

These are the frontend specific implementations of DIPLOMAT’s core functionalities. When you run diplomat track, diplomat tweak, diplomat annotate, diplomat supervised, or diplomat unsupervised, you are calling these functions, as those commands determine the correct implementation based on the config file you pass. Therefore, you will likely almost never call these functions directly, but they are included as they list all settings that a backend supports.

`diplomat deeplabcut analyze_videos`	Run DIPLOMAT tracking on videos using a DEEPLABCUT project and trained network.
`diplomat deeplabcut analyze_frames`	Takes a DIPLOMAT Frame Store file (.dlfs) and makes predictions for the stored frames, using whatever predictor plugin is selected. This allows for the video to be run through the Deep Neural Network once, and then run through several prediction algorithms as many times as desired, saving time. It also allows for frames to be processed on one computer to be transferred to another computer for post-processing and predictions.
`diplomat deeplabcut label_videos`	Create labeled videos using results generated by DIPLOMAT’s DEEPLABCUT frontend.
`diplomat deeplabcut tweak_videos`	Make minor modifications and tweaks to tracked results produced by DEEPLABCUT (or DIPLOMAT) using the supervised UI.
`diplomat deeplabcut convert_results`	Convert DeepLabCut tracking results (.h5 file) to a csv file for easier introspection and analysis.
`diplomat sleap analyze_videos`	Run DIPLOMAT tracking on a set of videos or a single video using a SLEAP model, generating results in “.slp” files.
`diplomat sleap analyze_frames`	Run DIPLOMAT tracking on a set of frame store files or a single frame store using metadata from a SLEAP model, generating results in “.slp” files.
`diplomat sleap label_videos`	Label videos tracked using the SLEAP frontend.
`diplomat sleap tweak_videos`	Make minor modifications and tweaks to sleap results (stored in .slp files) using DIPLOMAT’s supervised UI.
`diplomat sleap convert_results`	Convert diplomat generated results for SLEAP (in .slp format) to a csv based table format for easier analysis of results. The csv will have the same name and file path as the original .slp file, just a different extension.
`diplomat csv label_videos`	Labeled videos with arbitrary csv files in diplomat’s csv format.
`diplomat csv tweak_videos`	Make minor modifications and tweaks to arbitrary csv files using DIPLOMAT’s supervised UI.