GitBook: [master] 25 pages and 6 assets modified

Paperspace · Feb 11, 2020 · 8bd3662 · 8bd3662
1 parent 1e49ffb
commit 8bd3662
Show file tree

Hide file tree

Showing 31 changed files with 102 additions and 31 deletions.
diff --git a/.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm (1).png b/.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm (1).png
diff --git a/.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm.png b/.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm.png
diff --git a/.gitbook/assets/screen-shot-2020-02-10-at-7.57.10-pm.png b/.gitbook/assets/screen-shot-2020-02-10-at-7.57.10-pm.png
diff --git a/.gitbook/assets/screen-shot-2020-02-10-at-7.59.50-pm.png b/.gitbook/assets/screen-shot-2020-02-10-at-7.59.50-pm.png
diff --git a/.gitbook/assets/tagging-entity-add.gif b/.gitbook/assets/tagging-entity-add.gif
diff --git a/.gitbook/assets/tagging-entity-remove.gif b/.gitbook/assets/tagging-entity-remove.gif
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -164,3 +164,8 @@
 * [Product release notes](https://updates.paperspace.com/)
 * [CLI/SDK Release notes](https://github.com/Paperspace/gradient-cli/releases)
 
+## Tags
+
+* [Overview](tags/overview.md)
+* [Using Tags](tags/using-tags.md)
+
diff --git a/data/managing-data-in-gradient/README.md b/data/managing-data-in-gradient/README.md
@@ -10,7 +10,7 @@
 
 When opening your notebook you will see a `/storage` folder. Clicking on the folder will take you to Persistent Storage where you can upload your data.  If there are a large amount of files, it's advisable to zip them up first. 
 
-![](../../.gitbook/assets/image%20%2871%29.png)
+![](../../.gitbook/assets/image%20%2872%29.png)
 
 #### From a Virtual Machine \(VM\)
 

diff --git a/deployments/about.md b/deployments/about.md
@@ -11,7 +11,7 @@ description: >-
 
 Deploy any model as a high-performance, low-latency micro-service with a RESTful API. Easily monitor, scale, and version deployments. Deployments take a trained model and expose them as a persistent service at a known, secure URL endpoint.
 
-![](../.gitbook/assets/image%20%2888%29.png)
+![](../.gitbook/assets/image%20%2889%29.png)
 
 ## Current Capabilities
 

diff --git a/deployments/deployment-containers/custom-deployment-containers.md b/deployments/deployment-containers/custom-deployment-containers.md
@@ -6,7 +6,7 @@ Gradient provides the ability to use any public or private Docker container.  Th
 
 {% tabs %}
 {% tab title="Web UI" %}
-![](../../.gitbook/assets/image%20%2861%29.png)
+![](../../.gitbook/assets/image%20%2862%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}

diff --git a/experiments/about.md b/experiments/about.md
@@ -98,5 +98,5 @@ An experiment goes through a number of "states" between being submitted to Gradi
 | `EXPERIMENT_STATE_CANCELLED` | Cancelled |
 | `EXPERIMENT_STATE_ERROR` | Error |
 
-![](../.gitbook/assets/image%20%2866%29.png)
+![](../.gitbook/assets/image%20%2867%29.png)
 
diff --git a/experiments/using-experiments/README.md b/experiments/using-experiments/README.md
@@ -153,11 +153,11 @@ The gradient SDK enables programmatic automation of machine learning pipelines i
 {% tab title="Web UI" %}
 Open the Project that contains the Experiment:  
 
-![](../../.gitbook/assets/image%20%2858%29.png)
+![](../../.gitbook/assets/image%20%2859%29.png)
 
 Then click on the Experiment to view information about it:
 
-![](../../.gitbook/assets/image%20%2886%29.png)
+![](../../.gitbook/assets/image%20%2887%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}
@@ -175,7 +175,7 @@ gradient experiments details
 {% tab title="Web UI" %}
 To cancel an Experiment, click the Cancel button below the state indicator:
 
-![](../../.gitbook/assets/image%20%2869%29.png)
+![](../../.gitbook/assets/image%20%2870%29.png)
 
 To Stop an Experiment, click the Stop button below the state indicator:
 
@@ -197,7 +197,7 @@ gradient experiments stop
 {% tab title="Web UI" %}
 To Delete an Experiment, click the Stop button below the state indicator:
 
-![](../../.gitbook/assets/image%20%2840%29.png)
+![](../../.gitbook/assets/image%20%2841%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}

diff --git a/experiments/using-experiments/experiment-logs.md b/experiments/using-experiments/experiment-logs.md
@@ -6,7 +6,7 @@ Log streaming is available in both the web UI and CLI.  It is also possible to s
 {% tab title="Web UI" %}
 Navigate to a Job run part of an Experiment to view its logs.  These logs are streamed in realtime while the Experiment runs.  There are a few options such as Search, View all Logs, and Download Logs available on the page.  
 
-![](../../.gitbook/assets/image%20%2831%29.png)
+![](../../.gitbook/assets/image%20%2832%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}

diff --git a/experiments/using-experiments/experiment-metrics/system-metrics.md b/experiments/using-experiments/experiment-metrics/system-metrics.md
@@ -2,5 +2,5 @@
 
 System metrics display the utilization on the host where your Job is running:
 
-![](../../../.gitbook/assets/image%20%2850%29.png)
+![](../../../.gitbook/assets/image%20%2851%29.png)
 
diff --git a/experiments/using-experiments/git-commit-tracking.md b/experiments/using-experiments/git-commit-tracking.md
@@ -10,5 +10,5 @@ gradient experiments run ... --workspaceRef 68ace0d9881a968e6470accbff60a6d6728f
 
 The commit is now tracked as an Experiment parameter:
 
-![](../../.gitbook/assets/image%20%2851%29.png)
+![](../../.gitbook/assets/image%20%2852%29.png)
 
diff --git a/get-started/install-the-cli.md b/get-started/install-the-cli.md
@@ -86,7 +86,7 @@ gradient experiments run ... --apiKey XXXXXXXXXXXXXXXXXXX
 
 First, sign in to your [Paperspace account](https://www.paperspace.com/account/login). On the left of your home console, you will find an 'API' section. There, you'll find a form where you can create API keys. You'll use the API keys you generate here to authenticate your requests.
 
-![API keys section of the console \(https://www.paperspace.com/console/account/api\)](../.gitbook/assets/image%20%2829%29.png)
+![API keys section of the console \(https://www.paperspace.com/console/account/api\)](../.gitbook/assets/image%20%2830%29.png)
 
 ## Enable autocomplete
 

diff --git a/get-started/quick-start.md b/get-started/quick-start.md
@@ -21,7 +21,7 @@ Notebooks can be created by clicking _Create Notebook_ button on the Notebooks t
 Check out the [FREE GPU](../instances/free-instances.md) option when launching Notebooks!
 {% endhint %}
 
-![](../.gitbook/assets/image%20%2865%29.png)
+![](../.gitbook/assets/image%20%2866%29.png)
 
 ## Submit an Experiment
 

diff --git a/gradient-private-cloud/gradient-node/gradient-ami.md b/gradient-private-cloud/gradient-node/gradient-ami.md
@@ -34,13 +34,13 @@ Starting a gradient-node from the AMI is simple: select the AMI from the AWS Mar
 7. Launch your new instance
 8. On boot, the instance will automatically register with your Gradient account and will be ready to accept Jobs.  See the [usage](usage.md) section for submitting jobs to a Gradient node.
 
-![Once provisioned, the Gradient node will auto register with your account.](../../.gitbook/assets/image%20%2876%29.png)
+![Once provisioned, the Gradient node will auto register with your account.](../../.gitbook/assets/image%20%2877%29.png)
 
 ## Passing credentials via user-data \(preferred\)
 
 You can pass credentials into the Gradient° instance at launch time, which enables the node to start automatically and associate itself in your account. You would not have to SSH into the running instance to configure the gradient-node. Below is the text you should copy into the user-data field under "Advanced Details" in Step 3, "Configure Instance Details," when launching an EC2 instance:
 
-![](../../.gitbook/assets/image%20%2854%29.png)
+![](../../.gitbook/assets/image%20%2855%29.png)
 
 ```text
 #cloud-config

diff --git a/gradient-private-cloud/usage.md b/gradient-private-cloud/usage.md
@@ -4,7 +4,7 @@
 
 Your clusters are available under the _Private Clusters_ [page](https://www.paperspace.com/console/clusters) in the Paperspace console.  Here you can find information about your cluster, including your cluster ID – you will need to specify this ID in order to designate your private cluster as the place to run experiments, notebooks, etc. 
 
-![](../.gitbook/assets/image%20%2868%29.png)
+![](../.gitbook/assets/image%20%2869%29.png)
 
 ## **Using Gradient Private Cloud via the Gradient CLI**
 

diff --git a/jobs/create-a-job/README.md b/jobs/create-a-job/README.md
@@ -8,7 +8,7 @@ This feature is currently only available to our Gradient hosted offering. [Conta
 
 {% tabs %}
 {% tab title="Web UI" %}
-![](../../.gitbook/assets/image%20%2836%29.png)
+![](../../.gitbook/assets/image%20%2837%29.png)
 
 Jobs can be submitted via the Job Builder.  There are a variety of optional and required options for your job including the instance type, the command, the container, etc.  Note: At the top of the screen, you'll see a few job presets which will give a sense for how these options work.  
 

diff --git a/jobs/create-a-job/job-metrics/system-metrics.md b/jobs/create-a-job/job-metrics/system-metrics.md
@@ -2,5 +2,5 @@
 
 System metrics display the utilization on the host where your Job is running:
 
-![](../../../.gitbook/assets/image%20%2832%29.png)
+![](../../../.gitbook/assets/image%20%2833%29.png)
 
diff --git a/models/about.md b/models/about.md
@@ -6,7 +6,7 @@ description: Overview of machine learning Models in Gradient
 
 The Gradient model repository is a hub for importing, managing, and deploying ML models. Gradient offers the ability to create your own **custom models** and in addition to launching pre-trained **public models**.
 
-![](../.gitbook/assets/image%20%2853%29.png)
+![](../.gitbook/assets/image%20%2854%29.png)
 
 Gradient Models can be created in two ways: they can be 1\) generated by running machine learning Experiments, or 2\) imported into Gradient by uploading them directly from the Web UI or CLI. Learn more [here](create-a-model/).
 

diff --git a/notebooks/create-a-notebook/README.md b/notebooks/create-a-notebook/README.md
@@ -10,7 +10,7 @@ Notebooks can be created by clicking _Create Notebook_ button on the Notebooks t
 
 These are the templates that are most popular on Gradient.  They include the most common ML frameworks and libraries.  [Click here](../notebook-containers/) to discover which Notebook Base Container will best suit your use case, then choose it from the options below:
 
-![](../../.gitbook/assets/image%20%2875%29.png)
+![](../../.gitbook/assets/image%20%2876%29.png)
 
 #### All Containers \(Basic\)
 
@@ -22,13 +22,13 @@ These are additional templates that are made available in Gradient as a 1-click
 
 If you need to import an existing container, visit the Custom Containers section. Learn more [here](../notebook-containers/).
 
-![](../../.gitbook/assets/image%20%2867%29.png)
+![](../../.gitbook/assets/image%20%2868%29.png)
 
 ### Choose the instance type
 
 This is [instance type](../../instances/instance-types.md) that your notebook will run on. Our hardware is configured to work with the tools and packages in each of the provided containers.
 
-![](../../.gitbook/assets/image%20%2849%29.png)
+![](../../.gitbook/assets/image%20%2850%29.png)
 
 ### Optional Settings:
 

diff --git a/notebooks/create-a-notebook/fork-a-notebook.md b/notebooks/create-a-notebook/fork-a-notebook.md
@@ -6,7 +6,7 @@ Forking is a great way to make a copy of your Notebook; to save a version of it
 
 Click the Fork icon to the right of a notebook:
 
-![](../../.gitbook/assets/image%20%2879%29.png)
+![](../../.gitbook/assets/image%20%2880%29.png)
 
 You will see an exact copy of your notebook appear at the top of your Notebooks list.
 
diff --git a/notebooks/notebook-containers/README.md b/notebooks/notebook-containers/README.md
@@ -33,7 +33,7 @@ Custom containers feature lets you pull your own image from a container registry
 
 * Container Name = Path and tags of image eg `ufoym/deepo:all-jupyter-py36`
 
-![](../../.gitbook/assets/image%20%2884%29.png)
+![](../../.gitbook/assets/image%20%2885%29.png)
 
 #### Optional fields:
 

diff --git a/notebooks/notebook-containers/building-a-custom-container.md b/notebooks/notebook-containers/building-a-custom-container.md
@@ -90,7 +90,7 @@ Just pass in the container when creating your Experiment
 
 #### Using the Experiment Builder UI
 
-![](../../.gitbook/assets/image%20%2835%29.png)
+![](../../.gitbook/assets/image%20%2836%29.png)
 
 #### Using the CLI
 

diff --git a/paperspace-account/gradient-public-profiles.md b/paperspace-account/gradient-public-profiles.md
@@ -23,15 +23,15 @@ There, click `Profile` in the dropdown menu. This will take you to your current
 
 Click `Edit Profile` to set your user or team handle, public profile description, and more.
 
-![](../.gitbook/assets/image%20%2825%29.png)
+![](../.gitbook/assets/image%20%2826%29.png)
 
 Your user/team handle follows a GitHub-style convention and will be accessible at **https://www.paperspace.com/{your\_handle}**
 
 ## **Sharing public notebooks**
 
 [Public notebooks](../notebooks/public-notebooks.md) are a new feature in Gradient.  They allow you to run a [Jupyter notebook](https://jupyter.org/) and easily share it with others. A Gradient Notebook is actually an entire self-contained container with all libraries, dependencies, and files contained within it. This means that you can easily create complex ML applications without worrying about having others run install scripts, run into dependency management issues, and more.
 
-![](../.gitbook/assets/image%20%2824%29.png)
+![](../.gitbook/assets/image%20%2825%29.png)
 
 Once a notebook is made `Public` it will show up under your public profile for others to view and fork into their own account. 
 

diff --git a/projects/managing-projects.md b/projects/managing-projects.md
@@ -6,11 +6,11 @@
 {% tab title="Web UI" %}
 On the Projects page, click _Create Project_ and select _Create Standalone Project_.
 
-![](../.gitbook/assets/image%20%2877%29.png)
+![](../.gitbook/assets/image%20%2878%29.png)
 
 Provide a name and then click _Create Project_.
 
-![](../.gitbook/assets/image%20%2872%29.png)
+![](../.gitbook/assets/image%20%2873%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}
@@ -48,7 +48,7 @@ If you haven't yet connected your GitHub account, follow the prompts to grant ac
 
 Then, select the GitHub repo from the dropdown list:
 
-![](../.gitbook/assets/image%20%2839%29.png)
+![](../.gitbook/assets/image%20%2840%29.png)
 {% endtab %}
 
 {% tab title="CLI" %}

diff --git a/tags/overview.md b/tags/overview.md
@@ -0,0 +1,22 @@
+---
+description: 'Add, edit, and filter on tags across all of a team''s Gradient entities'
+---
+
+# Overview
+
+{% hint style="warning" %}
+Tags are currently in Private Beta and are coming soon to Gradient Enterprise and SaaS.
+{% endhint %}
+
+Tags are a powerful feature in Gradient that allow teams to organize and track machine learning work.
+
+A tag is simply an alphanumeric word or phrase scoped to a team that team members can apply to any taggable entity and then use to filter entity list results. Taggable entity types include Projects, Experiments, Notebooks, Jobs, Models, and Deployments.
+
+![Projects list filtered on &apos;PyTorch&apos; tag shows 8 projects with that tag](../.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm.png)
+
+Team admins and entity creators can add tags to entities, and all team members can filter any entity on any tag. Any time a team member adds a tag that doesn't already exist within their team, it becomes available to be used across all entities.
+
+
+
+_Read on to learn how to add and filter on tags._
+
diff --git a/tags/using-tags.md b/tags/using-tags.md
@@ -0,0 +1,44 @@
+# Using Tags
+
+## Adding, Creating, Removing, and Filtering on Tags
+
+### Adding Tags to Entities
+
+Team admins can add new and existing tags to any of their team's entities, and team members can add new and existing tags to entities that they created. Any new tag that is added, will become available for use across all of a team's entities.
+
+{% tabs %}
+{% tab title="Web UI" %}
+To add, create, or remove tags on any taggable entity, click the **Tag** button. This will open the **Edit Tags** modal, where you can: 1\) see any current tags on that entity; 2\) create and add new tags; and 3\) remove current tags. After you've added or removed tags, click **Submit** to finalize your changes.
+
+![Adding tags to a project, one new and one existing](../.gitbook/assets/tagging-entity-add.gif)
+
+![Removing tags from a project](../.gitbook/assets/tagging-entity-remove.gif)
+{% endtab %}
+
+{% tab title="CLI" %}
+
+{% endtab %}
+{% endtabs %}
+
+
+
+### Filtering Entities on Tags
+
+{% tabs %}
+{% tab title="Web UI" %}
+To find entities with a specific tag, first click the **Filter by tags** dropdown at the top of any entity list, such as Projects below.
+
+![Filter by tags dropdown where you can select tags to filter on](../.gitbook/assets/screen-shot-2020-02-10-at-7.59.50-pm.png)
+
+Then, type or select tags to filter that entity on. This will result in all entities, such as Projects below, that match any selected tag.
+
+![Project results that match the that being filtered on](../.gitbook/assets/screen-shot-2020-02-10-at-7.25.47-pm%20%281%29.png)
+{% endtab %}
+
+{% tab title="CLI" %}
+
+{% endtab %}
+{% endtabs %}
+
+
+
diff --git a/tensorboards/about.md b/tensorboards/about.md
@@ -10,7 +10,7 @@ Gradient TensorBoards are a Gradient Enterprise feature. [Contact Sales](https:/
 
 **TensorBoard** is a popular open source visualization software that comes with any standard TensorFlow installation but is a first class citizen in other frameworks such as PyTorch. 
 
-![](../.gitbook/assets/image%20%2873%29.png)
+![](../.gitbook/assets/image%20%2874%29.png)
 
 Here's a description of the TensorBoard project by Google: