You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
See slack messages starting here but also elsewhere by searching for docs or documentation.
ClearML is great, but I often find myself rummaging through the GitHub code for more information, or asking silly questions on Slack simply because the documentation is somewhat lacking.
To be precise, the documentation is:
Rather complete in terms of SDK documentation
Very lacking in terms of usage documentation
SDK documentation is very messy
I think ClearML and the users would benefit greatly from mirroring the numpy ecoysystem's documentation style.
That is, documentation should:
Include an overview of how different elements/SDK instructions interact with each other (agent, queue, remote execution, configuration files, artifacts, storage manager, etc)
SDK documentation should be easy to read, easy to find formatting issues, easy to search through (e.g. one long page for Task is simply difficult to navigate through).
ClearML's documentation is constantly being added to and improved and your feedback goes a long way in pointing us in an effective direction.
As a side-note, appreciate if you can make the issue title a little more precise, as "Improve Documentation" will probably always be applicable in one manner of another :)
See slack messages starting here but also elsewhere by searching for
docs
ordocumentation
.ClearML is great, but I often find myself rummaging through the GitHub code for more information, or asking silly questions on Slack simply because the documentation is somewhat lacking.
To be precise, the documentation is:
I think ClearML and the users would benefit greatly from mirroring the numpy ecoysystem's documentation style.
That is, documentation should:
Task
is simply difficult to navigate through).As an example, consider pandas documentation:
The text was updated successfully, but these errors were encountered: