Metadata

utils.metadata.create_PE_project(project_name, data_directory, data_source, output_directory, fps)[source]

Make project directory and write config_PE.yaml file.

Parameters:

  • project_name – what to call your creation

  • data_directory – path to source data

  • data_source – DeepLabCut or SLEAP

  • output_directory – path where output directory and config file should be created

  • fps – frames per second

Returns:

path to saved config (in specified output directory)

utils.metadata.create_PS_project(project_name, data_directory, data_source, output_directory, fps, n_modules)[source]

Make project directory and write config_PS.yaml file.

Parameters:

  • project_name – what to call your creation

  • data_directory – path to source data

  • data_source – B-SOiD, VAME, or Keypoint-MoSeq

  • output_directory – path where output directory and config file should be created

  • fps – frames per second

  • n_modules – number of pose states / modules

Returns:

path to saved config (in specified output directory)

utils.metadata.load_project(config_path)[source]

Loads project from config_PS.yaml or config_PE.yaml file

Parameters:

config_path – path to config file:

utils.metadata.save_edited_project(config, config_path)[source]

Loads project from config_PS.yaml or config_PE.yaml file

Parameters:

config_path – path to config file: