Skip to content

Commit 99a3adc

Browse files
committed
update README
1 parent db55c96 commit 99a3adc

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
## My Project
1+
:warning: **Warning**: This repository is experimental software designed for trial use. It may change significantly in the future and there is no guarantee of support. Please do use it and give us feedback on what we could improve, but take its experimental nature into account.
22

3-
TODO: Fill this README out!
3+
![SageMaker](https://github.com/aws/sagemaker-example-notebooks-testing/raw/master/branding/icon/sagemaker-banner.png)
44

5-
Be sure to:
5+
# SageMaker Example Notebooks Testing
66

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
7+
A continuous integration (CI) system for Jupyter notebooks, built using Amazon SageMaker.
98

10-
## Security
9+
## :books: Background
1110

12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
11+
[Amazon SageMaker](https://aws.amazon.com/sagemaker/) is a fully managed service for data science and machine learning (ML) workflows.
12+
You can use Amazon SageMaker to simplify the process of building, training, and deploying ML models.
1313

14-
## License
14+
The [SageMaker example notebooks](https://sagemaker-examples.readthedocs.io/en/latest/) are Jupyter notebooks that demonstrate the usage of Amazon SageMaker.
1515

16-
This project is licensed under the Apache-2.0 License.
16+
This **SageMaker Example Notebooks Testing** repository contains the code for the open-source CI system for the example notebooks.
17+
It can be repurposed to build a CI system for your own Jupyter notebooks on SageMaker.
1718

19+
## :balance_scale: License
20+
21+
This library is licensed under the [Apache 2.0 License](http://aws.amazon.com/apache2.0/).
22+
For more details, please take a look at the [LICENSE](https://github.com/aws/sagemaker-example-notebooks-testing/blob/master/LICENSE) file.
23+
24+
## :handshake: Contributing
25+
26+
Contributions are welcome!
27+
Please read our [contributing guidelines](https://github.com/aws/sagemaker-example-notebooks-testing/blob/master/CONTRIBUTING.md)
28+
if you'd like to open an issue or submit a pull request.

branding/icon/sagemaker-banner.png

9.17 KB
Loading

0 commit comments

Comments
 (0)