Skip to content

fix: typos in README.md #82

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
14 changes: 7 additions & 7 deletions mlops-multi-account-tf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ As enterprise businesses embrace Machine Learning (ML) across their organisation

## High level architecture

In this repository, we show how to use **Terraform** with **GitHub and GitHub Actions** to build a baseline infratsturcture for secure MLOps. The solution can be broken down into three parts:
In this repository, we show how to use **Terraform** with **GitHub and GitHub Actions** to build a baseline infrastructure for secure MLOps. The solution can be broken down into three parts:

**Base Infrastructure**

The necessary infrastructure componenets for your accounts including SageMaker Studio, Networking, Permissions and SSM Parameters.
The necessary infrastructure components for your accounts including SageMaker Studio, Networking, Permissions and SSM Parameters.

<img src="./architecture/base-infra.png" alt="drawing" width="500"/>

Expand All @@ -26,7 +26,7 @@ This is how the end-users (Data Scientists or ML Engineers) use SageMaker projec

Typically, when a SageMaker project is deployed:
- GitHub private repos are created from templates that Data Scientists need to customize as per their use-case.
- These tempalates show best practices such as testing, approvals, and dashboards. They can be fully customized once deployed.
- These templates show best practices such as testing, approvals, and dashboards. They can be fully customized once deployed.
- Depending on the chosen SageMaker project, other project specific resources might also be created such as a dedicated S3 bucket for the project and automation to trigger ML deployment from model registry.

An architecture for the `Building, training, and deployment` project is shown below.
Expand All @@ -37,7 +37,7 @@ Currently, three example project template are available.

1. **MLOps Template for Model Building, Training, and Deployment**: ML Ops pattern to train models using SageMaker pipelines and to deploy the trained model into preproduction and production accounts. This template supports Real-time inference, Batch Inference Pipeline, and BYOC containers.

2. **MLOps Template for promoting the full ML pipeline across environments**: ML Ops pattern to shows how to take the same SageMaker pipeline across environements from dev to prod.
2. **MLOps Template for promoting the full ML pipeline across environments**: ML Ops pattern to show how to take the same SageMaker pipeline across environements from dev to prod.

3. **MLOps Template for Model Building and Training**: MLOps pattern that shows a simple one-account SageMaker Pipeline setup.

Expand Down Expand Up @@ -121,8 +121,8 @@ This one-time deployment create the following resources in your AWS account:

- For Terrafrom Backend:
- S3 Bucket to store state files.
- DynamoDB table to store state locking.
- AWS Idenitity provider for GitHub actions using OIDC (as explained above)
- DynamoDB table to store state locking.
- AWS Identity provider for GitHub actions using OIDC (as explained above)
- IAM Role to assume from GitHub Actions using the identity provider.

Once this is deployed, you're ready to move on to the next step.
Expand All @@ -131,7 +131,7 @@ Once this is deployed, you're ready to move on to the next step.

We will move the code from this example to your GitHub Organization.

1. [base-infrastructure](./base-infrastructure/): An internal reposotry for Base Infrastructure which wil contain all code from `./sagemaker-mlops-terraform` folder.
1. [base-infrastructure](./base-infrastructure/): An internal repository for Base Infrastructure which will contain all code from `./sagemaker-mlops-terraform` folder.
2. [template-repos](./template-repos/): GitHub [template repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository) with code from `./template-repos/**`. Make sure to use the same name as the folder name.

> **_Note_:** This is an important step to be able to deploy infrastructure. All further steps should be performed directly in your GitHub Organization.
Expand Down