[onert] Add brief doc for training example Python script #16335
Conversation
This commit adds documentation for train_step_with_dataset.py script. It shows how to prepare input and label files in the format expected by the script. ONE-DCO-1.0-Signed-off-by: Arkadiusz Bokowy <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the train_step_with_dataset.py training example script and fixes markdownlint issues across documentation files in the runtime/onert/sample/minimal-python directory. The documentation provides clear instructions on dataset preparation, expected formats, and example usage for the training workflow.
Key changes:
- Added new documentation file explaining the training example with dataset preparation instructions
- Fixed markdown formatting issues (blank lines and code block language specifications) across 4 existing documentation files
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
runtime/onert/sample/minimal-python/experimental/src/train_step_with_dataset.md |
New comprehensive documentation for the training example, including dataset preparation guide and usage instructions |
runtime/onert/sample/minimal-python/minimal.md |
Added blank line before list items (markdownlint fix) |
runtime/onert/sample/minimal-python/inference_benchmark.md |
Added blank lines and changed code block language from unspecified to text (markdownlint fix) |
runtime/onert/sample/minimal-python/dynamic_shape_inference.md |
Added blank line after "Purpose" header (markdownlint fix) |
runtime/onert/sample/minimal-python/README.md |
Changed code block language from unspecified to bash (markdownlint fix) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --input=dataset.npy \ | ||
| --label=labels.npy \ | ||
| --batch_size=16 \ | ||
| --data_length=1 |
There was a problem hiding this comment.
The example creates a dataset with 16 samples (line 24: data = np.random.rand(16, 224, 224, 3)), but the command line shows --data_length=1 (line 43). The data_length parameter should match the number of samples in the dataset. This should be --data_length=16 to match the 16 samples created in the example.
| --data_length=1 | |
| --data_length=16 |
1 participant
This PR adds documentation for
train_step_with_dataset.pyscript. It shows how to prepare input and label files in the format expected by the script.Also, it fixes issues reported by
markdownlintin other documentations files in theruntime/onert/sample/minimal-pythondirectory.ONE-DCO-1.0-Signed-off-by: Arkadiusz Bokowy [email protected]