catalystneuro / vame-desktop

A desktop application for the Variational Animal Motion Encoding project.
GNU General Public License v3.0
1 stars 0 forks source link

format changes for 'Edit Project' tab #5

Closed katiekly closed 3 weeks ago

katiekly commented 1 month ago

On this page, we'd like to have the parameters split into two categories: 'Main Configurations' and ' Advanced Configurations', where the all the 'Main Configuration' parameters will be displayed and the 'Advanced Configurations' parameters would be hidden. The 'Advanced Configurations' parameters can be displayed by clicking on the 'Advanced Configurations' drop down arrow.

It'd also be nice to have descriptions of each parameter by including a small info icon for users to hover over to display the parameter description.

Below, I outlined how the parameters should be categorized and noted any specifications of a parameter.

Main Configurations:

Advanced Configurations:

garrettmflynn commented 1 month ago

Awesome. Thank you @katiekly!

garrettmflynn commented 3 weeks ago

@katiekly Has anyone on the team worked with JSON Schema before? I'll need the configuration file annotated with this—but, after that, I'll be able to automatically generate a form that applies all of these constraints and formatting options.

garrettmflynn commented 3 weeks ago

Got an outline started here if you wouldn't mind submitting a PR with additional values, as well as checking for accuracy: https://github.com/catalystneuro/vame-desktop/blob/main/src/schema/config.schema.json

garrettmflynn commented 3 weeks ago

Worth noting that the default values of the current VAME library are not the values you identified above. Is this expected? In an ideal world, we'd want the default configuration to be generated from this schema—so IMO they should not be different.

katiekly commented 3 weeks ago

@garrettmflynn I've briefly worked with JSON a long time ago, I think I can figure it out with the template you created. Thanks for noting the difference in default values. The default values I mentioned before aligns with our pipeline/set-up, hence the difference from the default values you found in the VAME library.

I'll go over the configurations parameters and submit a PR.