Skip to content

Commit ed4b98c

Browse files
adding readme comments
1 parent ea2cc6e commit ed4b98c

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
## what does it do
44

55
The Tool will be used to deploy on skypilot. It aims to simplify the deployment process.
6-
In the end, the application needs to merge different .yaml files (pyMc-/user Files) together
6+
In the end, the application needs to merge different .yaml files (pyMc-/user Files) together.
7+
8+
The library can be used and configured in 3 forms
9+
10+
- via a Python API and by passing configuration as parameters
11+
- via the CLI and YAML files for configuration
12+
- via the CLI and command line parameters for configuration.
13+
714
# Quickstart
815

916
## Installation
@@ -25,7 +32,7 @@ cd PyMC-Server
2532
pip3 install . # run `pip3 install -e .` if you want to be able to edit the code
2633
```
2734

28-
### Setting up a cloud: Google Cloud
35+
## Setting up a cloud: Google Cloud
2936

3037
1. Run `pymcs check` to see if you already have credentials setup. If you see a green checkmark for GCP (Google Cloud Platform), skip to the next section
3138
2. Install the google cloud SDK and authenticate.
@@ -71,7 +78,12 @@ roles/iam.securityAdmin
7178

7279
>Note: If you use PyMC-Server as part of an organization, your GCP admin might have setup a role already (e.g. `pymc-server-role `) and you can easily attach your user to it.
7380
74-
### Status of your deployments
81+
# Yaml configuration
82+
# Command Line Usage
83+
## Start a new single or multi-node cluster (with YAML configuration)
84+
Setup a configuration file (see #Yaml-configuration)
85+
## Start a new single or multi-node cluster (with CLI parameter configuration)
86+
## Status of your deployments
7587

7688
To check the status of all your deployments run `pymcs status`. A table is printed to your terminal.
7789

0 commit comments

Comments
 (0)