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

Missing docs: batch mode #96

Closed
ml-evs opened this issue Mar 19, 2024 · 1 comment · Fixed by #172
Closed

Missing docs: batch mode #96

ml-evs opened this issue Mar 19, 2024 · 1 comment · Fixed by #172
Labels
documentation Improvements or additions to documentation

Comments

@ml-evs
Copy link
Member

ml-evs commented Mar 19, 2024

Just raising an issue about the batch mode, which is not documented. In fact, the batch config model is just serving the docstring for BaseModel at https://matgenix.github.io/jobflow-remote/api/jobflow_remote.config.base.html#jobflow_remote.config.base.BatchConfig so it is very well hidden.

@ml-evs ml-evs added the documentation Improvements or additions to documentation label Mar 19, 2024
@gpetretto
Copy link
Contributor

The batch submission is now documented in the "Advanced options": https://matgenix.github.io/jobflow-remote/user/advancedoptions.html#batch-submission. I also added a small description in the docstrings https://matgenix.github.io/jobflow-remote/api/jobflow_remote.config.base.html#jobflow_remote.config.base.BatchConfig. Do you think this is enough?

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

Successfully merging a pull request may close this issue.

2 participants