Skip to content

Commit 6919cb4

Browse files
gushob21arueth
authored andcommitted
Fixing documentation (#268)
* Fixing documentation
1 parent bfc3e90 commit 6919cb4

File tree

2 files changed

+7
-11
lines changed

2 files changed

+7
-11
lines changed

ml-platform/04_setup_clusters/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You just followed `GitOps` to promote changes from `dev` to higher environments.
5454
Open the configsync repo and go to `manifests/clusters`, you will see there is a cluster selector created for each cluster via yaml files.
5555

5656
### Install a cluster scoped software
57-
This section describes how platform admins will use the configsync repo to manage cluster scoped software or cluster level objects. These softwares could be used by multiple teams in their namespaces. An example of such softwares is [kuberay][kuberay] that can manage ray clusters in multiple namespace.
57+
This section describes how platform admins will use the configsync repo to manage cluster scoped software or cluster level objects. These software could be used by multiple teams in their namespaces. An example of such software is [kuberay][kuberay] that can manage ray clusters in multiple namespace.
5858

5959

6060
Let's install [Kuberay][kuberay] as a cluster level software that includes CRDs and deployments. Kuberay has a component called operator that facilitates `ray` on Kubernetes. We will install Kuberay operator in default namespace. The operator will then orchestrate `ray clusters` created in different namespace by different teams in the future.

ml-platform/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,22 @@ It addresses following personae and provides means to automate and simplify thei
3535

3636
**CUJ 1** : Use ML tools like `ray` to perform their day to day tasks like data pre-processing, ML training etc.
3737

38-
**CUJ 2** : Use a development environment like Jupyter Notebook for faster inner loop of ML development.
38+
**CUJ 2** : Use a development environment like Jupyter Notebook for faster inner loop of ML development. **[TBD]**
3939

4040
### Operators
4141

42-
**CUJ 1**: Act as a bridge between the Platform admins and the ML Engineers by providing and maintaining softwares needed by the ML engineers so they can focus on their job.
42+
**CUJ 1**: Act as a bridge between the Platform admins and the ML Engineers by providing and maintaining software needed by the ML engineers so they can focus on their job.
4343

44-
**CUJ 2**: Deploying the models.
44+
**CUJ 2**: Deploying the models. **[TBD]**
4545

46-
**CUJ 3**: Building observability on the models.
46+
**CUJ 3**: Building observability on the models. **[TBD]**
4747

48-
**CUJ 4**: Operationalizing the models.
48+
**CUJ 4**: Operationalizing the models. **[TBD]**
4949

5050
## Prerequistes
5151

5252
1. This tutorial has been tested on [Cloud Shell](https://shell.cloud.google.com) which comes preinstalled with [Google Cloud SDK](https://cloud.google.com/sdk) is required to complete this tutorial.
5353

54-
2. It is recommended to start the tutorial in a fresh project since the easiest way to clean up once complete is to delete the project. See [here](https://cloud.google.com/resource-manager/docs/creating-managing-projects) for more details.
55-
56-
3. This tutorial requires a number of different GCP Quotas (>= 60 T4 GPUs and 400 CPU cores) in the region of your choosing. Please visit the [IAM -> Quotas page](https://console.cloud.google.com/iam-admin/quotas) in the context of your project and region to request additional quota before proceeding with this tutorial.
57-
5854
## Deploy resources.
5955

6056
Follow these steps in order to build the platform and use it.
@@ -69,7 +65,7 @@ Follow these steps in order to build the platform and use it.
6965

7066
- Run steps in [05_setup_teams][setup-teams]. This modules walks through how as platform admin you can set up spaces for ML teams on the cluster and transfer ownership to operators to maintain that space.
7167

72-
- Run steps in [06_operating_teams][operating-teams]. This module walks through how as an operator you will provide the softwares required by ML engineers.
68+
- Run steps in [06_operating_teams][operating-teams]. This module walks through how as an operator you will provide the software required by ML engineers.
7369

7470

7571
[projects]: ./01_gcp_project/README.md

0 commit comments

Comments
 (0)