Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommended practices for model configuration storage #218

Open
galenseilis opened this issue Oct 30, 2023 · 1 comment
Open

Recommended practices for model configuration storage #218

galenseilis opened this issue Oct 30, 2023 · 1 comment

Comments

@galenseilis
Copy link
Contributor

I am thinking about how to develop and maintain model configurations.

  • I could use ciw.create_network to develop an instance of the ciw.network class and then serialize it.
  • I could keep that configuration information in a format such as XML or JSON.
  • Or something else?

Whichever way I would want to keep things in a versioning system (git).

@geraintpalmer
Copy link
Member

We used to have .yml files for this, however it got much more complicated when some inputs were functions or objects, and it got a bit messy when combining with numpy arrays.

I find that the Python file itself if sufficient, as the inputs to ciw.create_network are so readable.

I would recommend keeping models as separate Python files creating the networks, and just importing them into the main script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants