Expanding metadata file

DeepLabCut / DLC2NWB

Utilities to convert DeepLabCut (DLC), output to/from Neurodata Without Borders (NWB) format.

MIT License

14 stars 7 forks source link

Expanding metadata file #4

Open AlexEMG opened 2 years ago

AlexEMG commented 2 years ago

DLC stores the following metadata:

https://github.com/DeepLabCut/DeepLabCut/blob/444da3da70b1f3bfaae39b0849e0aafcff1a9b7a/deeplabcut/pose_estimation_tensorflow/predict_videos.py#L750

(we are likely going to expand this in the near future). What other variables should be stored and could we put in NWB?

bendichter commented 2 years ago

Yes, let's include this. It expanding won't be a problem. The extension will be versioned and can be updated alongside this metadata file. @rly, do you think this should go in ndx-pose, or since this is really DLC-specific, should we make another extension that extends from ndx-pose and defines metadata specifically for DLC?

rly commented 2 years ago

@rly, do you think this should go in ndx-pose, or since this is really DLC-specific, should we make another extension that extends from ndx-pose and defines metadata specifically for DLC?

I prefer the latter option even though the arrangement is slightly more complex.

AlexEMG commented 2 years ago

We think one should add

the cropping parameters (that were used during inference), see https://github.com/DeepLabCut/DeepLabCut/blob/444da3da70b1f3bfaae39b0849e0aafcff1a9b7a/deeplabcut/pose_estimation_tensorflow/predict_videos.py#L762
and pose_cfg, which is a dictionary that has lots of parameters https://github.com/DeepLabCut/DeepLabCut/blob/444da3da70b1f3bfaae39b0849e0aafcff1a9b7a/deeplabcut/pose_estimation_tensorflow/predict_videos.py#L755

How do you want us to add them to ndx_pose. Shall we just add fields?