diplomat.core_ops.supervised

diplomat.core_ops.supervised(config: Union[List[Union[PathLike, str]], Union[PathLike, str]], videos: Optional[Union[List[Union[PathLike, str]], Union[PathLike, str]]] = None, frame_stores: Optional[Union[List[Union[PathLike, str]], Union[PathLike, str]]] = None, num_outputs: Optional[int] = None, settings: Optional[Dict[str, Any]] = None, help_extra: bool = False, **extra_args) → None[source]

Run diplomat in supervised mode on the specified config and videos or frame stores. An alias for DIPLOMAT track with the SupervisedSegmentedFramePassEngine predictor.

Parameters

  • config – The path to the configuration file for the project. The format of this argument will depend on the frontend.

  • videos – A single path or list of paths to video files to run analysis on.

  • frame_stores – A single path or list of paths to frame store files to run analysis on.

  • num_outputs – An integer, the number of bodies to track in the video. Defaults to 1.

  • settings – An optional dictionary, listing the settings to use for the SupervisedSegmentedFramePassEngine predictor plugin. If not specified, the frontend will determine the settings in a frontend specific manner. To see the settings the SupervisedSegmentedFramePassEngine supports, use the “diplomat predictors list_settings -p SupervisedSegmentedFramePassEngine” command or “diplomat.get_predictor_settings(‘SupervisedSegmentedFramePassEngine’)”. To get more information about how a frontend gets settings if not passed, set the help_extra parameter to True to print additional settings for the selected frontend instead of running tracking.

  • help_extra – Boolean, if set to true print extra settings for the automatically selected frontend instead of running tracking.

  • extra_args – Any additional arguments (if the CLI, flags starting with ‘–’) are passed to the automatically selected frontend. To see valid values, run track with extra_help flag set to true. Extra arguments that are not found in the frontend analysis function are thrown out.