Add examples on how to use the library in the README

Open Beginner friendly
#2 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

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.

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)

Dominant language
Python
Stars
26
Forks
19
Avg merge
1d 6h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/sagemaker-mlflow

All issues in aws/sagemaker-mlflow

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.