Skip to content

Document Python script examples #171

@deprit

Description

@deprit

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions