aws / aws/sagemaker-mxnet-training-toolkit
Improve Readme
- Dominant language
- Python
- Stars
- 60
- Forks
- 52
- PR merge metrics
- No merged PRs in 30d
Description
The current Readme gives a wrong notion that to build image one has to use Dockerfiles present in this repo
However, it looks like the Dockerfiles & tests folder have been migrated to https://github.com/aws/deep-learning-containers
That needs to be documented.
Also would be great to note
- What's the exact purpose of this repository?
- How is it different from the dlc repo?
- How do changes made in dlc repo [update to docker image for example] gets reflected in this repo?
Contributor guide
Research direction
Start with the repository README and compare its build description with the Dockerfiles and tests now hosted in aws/deep-learning-containers. Trace the relationship between this toolkit and the dlc repository, including how image changes are reflected here. Done means the README accurately explains this repository’s purpose, its distinction from dlc, the migration, and the update flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100