Skip to content

Add brief introduction and release steps #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
## Neuron Deep Learning Containers
## AWS Neuron Deep Learning Containers

TODO: Fill this README out!

Be sure to:

* Change the title in this README
* Edit your repository description on GitHub
AWS Neuron Deep Learning Containers (DLCs) are a set of Docker images for training and serving models on AWS Trainium and Inferentia instances using AWS Neuron SDK.

## Security

Expand All @@ -14,4 +9,3 @@ See [SECURITY](SECURITY.md) for more information.
## License

This project is licensed under the Apache-2.0 License.

17 changes: 17 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Creating a release

Follow the Github official [documentation](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) to create release.

* Step 4:
* Create a new tag for each release.
* The version number should be same as the one of packaged [AWS Neuron](https://awsdocs-neuron.readthedocs-hosted.com/en/latest/release-notes/index.html).
* Step 5:
* The target should always be "main" branch.
* Step 6:
* Choose "auto".
* Step 7:
* Title is same as version number.
* Step 8:
* Automatically generate release notes.
* Steps 9 - 12 can be skipped for now:
* No need to attach binaries. The Neuron DLC images are released in ECR. The releases of this repo are only pointing Dockerfiles.