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

Document Python script examples #171

Open
deprit opened this issue Aug 17, 2024 · 0 comments
Open

Document Python script examples #171

deprit opened this issue Aug 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@deprit
Copy link
Collaborator

deprit commented Aug 17, 2024

The Python scripts in examples/src/armory/examples need to document both the overall structure of the evaluations as individual functions and key details that may escape novice users. We can assume that the reader is an ML engineer who is proficient in Python and neural models and who is learning to use Armory Library.

  • Write introductory docstring describing example purpose and structure
  • Write docstrings for main functions of the example
  • Provide in-line comments for key steps or details.
@deprit deprit added the documentation Improvements or additions to documentation label Aug 17, 2024
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

No branches or pull requests

1 participant