AllenNeuralDynamics / AllenNeuralDynamics/aind-codeocean-utils

Simplify CodeOceanJob, particularly metadata handling

Open
#23 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
When trying to use `CodeOceanJob` to handle metadata tags correctly, I spent couple hours looking at the control flow, and I'm still not sure I get it. Some other inconsistencies were also confusing - wrappers around configuration objects in aind-codeocean-api that really were only renaming things. We should also support a reprocessing workflow - registration should be optional.

**Describe the solution you'd like**
I propose CodeOceanJob be organized as follows:
- Use `aind-codeocean-api`'s request/configuration objects directly for the Register, Run, and Capture steps.
- Add a `pass_metadata_to_result` flag, default True
- Add a `add_data_level_tags` flag, default True
- Ensure that all metadata tags are unique (use Set, rather than List)
- Make sure that Run+Capture can be used independently of Register+Run+Capture

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.