Skip to content
This repository has been archived by the owner on Apr 11, 2022. It is now read-only.

fix: capitalize all instances of Web UI #31

Merged
merged 1 commit into from Jan 6, 2020
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion experiments/about.md
Expand Up @@ -12,7 +12,7 @@ Experiments are used to train machine learning models. Gradient supports single-

Experiments can be run from the **Experiment Builder** web interface, our **CLI,** the **GradientCI** bot, or the **SDK**. Here is a quick overview and instructions for each option:

The **web UI** is great for getting familiar with Experiments and running sample projects.
The **Web UI** is great for getting familiar with Experiments and running sample projects.

{% page-ref page="using-experiments/" %}

Expand Down
5 changes: 1 addition & 4 deletions experiments/using-experiments/README.md
Expand Up @@ -4,7 +4,7 @@

There are three modes for Experiments:

**Single-node:** An Experiment that runs on a single compute instance. This option is very simple and is available in the web UI, CLI, and SDK.
**Single-node:** An Experiment that runs on a single compute instance. This option is very simple and is available in the Web UI, CLI, and SDK.

**Multi-node**: Run a distributed training Experiment on more than one compute instance. This option is more advanced and is available in the CLI and SDK only. You can view examples here and the .

Expand Down Expand Up @@ -204,6 +204,3 @@ gradient experiments delete
```
{% endtab %}
{% endtabs %}



2 changes: 1 addition & 1 deletion experiments/using-experiments/experiment-logs.md
@@ -1,6 +1,6 @@
# Experiment Logs

Log streaming is available in both the web UI and CLI. It is also possible to stream logs using the SDK.
Log streaming is available in both the Web UI and CLI. It is also possible to stream logs using the SDK.

{% tabs %}
{% tab title="Web UI" %}
Expand Down
4 changes: 2 additions & 2 deletions experiments/using-experiments/experiment-options.md
Expand Up @@ -2,13 +2,13 @@

{% tabs %}
{% tab title="Web UI" %}
## Experiment web UI Options List
## Experiment Web UI Options List

| Option | Description |
| :--- | :--- |
| **Machine Type** | This is the type of instance to run your Experiment's on. Many Experiments benefit from a machine with a GPU, but some can run just using a CPU. |
| **Container** | Experiments are run within a docker container. You can run a public or private container. Learn more [here](../containers-public-and-private.md). |
| **Workspace** | The workspace is the collection of code that is run. The options in the web UI are a Git repo \(eg [https://github.com/Paperspace/fast-style-transfer.git](https://github.com/Paperspace/fast-style-transfer.git)\) or _none_. The CLI offers more advanced options such as specifying a local directory, private Git repos, S3 buckets, and more. |
| **Workspace** | The workspace is the collection of code that is run. The options in the Web UI are a Git repo \(eg [https://github.com/Paperspace/fast-style-transfer.git](https://github.com/Paperspace/fast-style-transfer.git)\) or _none_. The CLI offers more advanced options such as specifying a local directory, private Git repos, S3 buckets, and more. |
| **Command** | The command is the entry point to the container. This is the line of code that will kick off your experiment's job. It could be a bash script `./run.sh` or `python main.py` as a few examples. |
| **Ports** | You have the option to attach a public IP automatically. Supports opening multiple ports simultaneously, separated by `:` . Learn more about opening ports [here](ports.md). |
| **Custom Metrics** | Enter a list of custom metrics to use with Gradient's statd client, such as percent\_failure or percent\_success. |
Expand Down
3 changes: 1 addition & 2 deletions get-started/quick-start.md
Expand Up @@ -51,9 +51,8 @@ Behind the scenes, your Experiment will be uploaded and executed on our cluster

### Monitor your Experiment progress

Experiments states transition from **Queued** > **Pending** > **Running**. Once the Experiment is in the **Running** state, you can watch your Experiment run in the CLI and web UI. An Experiment can complete with the following states: **Success, Cancelled, Error,** or **Failed**.
Experiments states transition from **Queued** > **Pending** > **Running**. Once the Experiment is in the **Running** state, you can watch your Experiment run in the CLI and Web UI. An Experiment can complete with the following states: **Success, Cancelled, Error,** or **Failed**.

Congratulations! You ran your first Experiment on Gradient 🚀

Experiments have a ton of functionality that this quick example doesn't cover. To learn more, view the [Experiments section](../experiments/about.md).

6 changes: 3 additions & 3 deletions gradient-private-cloud/gradient-node/usage.md
Expand Up @@ -49,9 +49,9 @@ The `--apiKey <key>` option is the only required parameter. However it may also

On startup gradient-node will attempt to register in the account associated with the provided api key, using a default or provided node name, and return a unique id for the name. By default it will use the local hostname as the name of the instance. Each time gradient-node is run with a unique name a new cluster machine entry with a unique id is created unless a node id is also provided. The `--name` option can be used to override the default name.

If a gradient-node instance with the same name already exists within the cluster then all running nodes with the same name will be eligible to run jobs. The Gradient web UI ****will only show one entry for each distinct node id however.
If a gradient-node instance with the same name already exists within the cluster then all running nodes with the same name will be eligible to run jobs. The Gradient Web UI ****will only show one entry for each distinct node id however.

If you run gradient-node on a second machine, either make sure the second machine has a distinct hostname, or provide the `--cluster` option with a distinct name. If you want the new instance to take over for an existing instance with the same name then you must stop any other currently running instances registered with that name. You can use the Gradient web UI to check for active running instances with that name.
If you run gradient-node on a second machine, either make sure the second machine has a distinct hostname, or provide the `--cluster` option with a distinct name. If you want the new instance to take over for an existing instance with the same name then you must stop any other currently running instances registered with that name. You can use the Gradient Web UI to check for active running instances with that name.

If you want to change the name of a gradient-node instance you can specify the `--id` option, along with the new name using the `--name` option. This will update the name associated with that gradient-node id.

Expand All @@ -65,7 +65,7 @@ If you are a registering gradient-node for the first time in your account, you c

After the first cluster is created, if you register a node specifying a different cluster name, then a new cluster with that new name will automatically be created. However, it will not be the default cluster for the account.

In the Gradient web UI you can change the cluster name for any cluster in your account and/or switch which cluster is currently the default. When scheduling jobs you can select the targeted cluster using the Paperspace CLI or API job create options. You may target a specific node within a cluster by specifying the name or the node attributes of the node.
In the Gradient Web UI you can change the cluster name for any cluster in your account and/or switch which cluster is currently the default. When scheduling jobs you can select the targeted cluster using the Paperspace CLI or SDK job create options. You may target a specific node within a cluster by specifying the name or the node attributes of the node.

## Jobs Scheduling

Expand Down
2 changes: 1 addition & 1 deletion models/create-a-model/README.md
Expand Up @@ -2,7 +2,7 @@

## Create a Model

There are two ways to create a Model in Gradient, and both can be done via the web UI or CLI:
There are two ways to create a Model in Gradient, and both can be done via the Web UI or CLI:

### 1\) Run an Experiment that generates a Model

Expand Down
2 changes: 1 addition & 1 deletion tutorials/dealing-with-gradient-deployments.md
Expand Up @@ -87,7 +87,7 @@ gradient deployments list
+---------------------+-----------------+----------------------------------------------------------------------+----------+---------------------------+
```

The list of deployments can also be accessed from the web UI.
The list of deployments can also be accessed from the Web UI.

![](../.gitbook/assets/grad-deploy-0.jpg)

Expand Down