Add examples on how to use the library in the README
Open
Beginner friendly
- Dominant language
- Python
- Stars
- 26
- Forks
- 19
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 1
Description
Going through the README it is not clear how to use the library.
It would be ideal to include examples, and/or links to some published notebooks and scripts (e.g. [here](https://github.com/aws/amazon-sagemaker-examples/blob/main/sagemaker-mlflow/sagemaker_training_mlflow.ipynb))
Contributor guide
Research direction
Start with the repository README and review the linked SageMaker MLflow notebook as a reference for useful examples. Update the README with clear library usage examples and/or links to published notebooks and scripts; done means a newcomer can understand how to use the library from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100