Implement AindBehaviorSessionModel

AllenNeuralDynamics / dynamic-foraging-task

Bonsai/Harp workflow for Dynamic Foraging with Python GUI for visualization and control

MIT License

5 stars 4 forks source link

Implement AindBehaviorSessionModel #799

Open alexpiet opened 3 weeks ago

alexpiet commented 3 weeks ago

https://allenneuraldynamics.github.io/Aind.Behavior.Services/api.base/session.html

[x] Implement session model. When a user loads a mouse, generate this schema and validate it.
[x] Save the model as a json file. Presumably in the TrainingFolder directory?
[x] Refactor the code such that this information is always pulled from the model, instead of loose variables in the Window class.
[ ] Add to NWB file (Not entirely clear where)
- Maybe this session model gets added into the AIND session metadata file, under parameters. Then it will be included in the NWB file

micahwoodard commented 5 days ago

@alexpiet it seems like this might be better created after a user tries to starts a session. What is the value of creating it when a user loads a mouse?

alexpiet commented 5 days ago

@micahwoodard You are right. I think it needs to be created before the session starts.

micahwoodard commented 4 days ago

@alexpiet just an idea but what if we made the model in the Foraging init and then updated it every time one of inputs are changed via the gui? And then save the version used for a session after the session has ended. I think that would make the refactoring part easier since a lot of variables are referenced before a model is currently created and it's hard to tell which ones.

alexpiet commented 4 days ago

That makes sense to me!

micahwoodard commented 4 days ago

Cool well then disregard the review on the pr. I need to do some refactoring. Is the plan still to add the model into the AIND session metadata file, under parameters to include in NWB file?

alexpiet commented 4 days ago

Long term, I think thats a good idea. The session metadata is being re-organized right now by some other people. For now I would put it in the behavior folder alongside the gui log and the .json file