ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-18 11:11:50 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

small edits (#80)

Browse Source
This commit is contained in:
pollfly 2021-10-05 09:02:44 +03:00 committed by GitHub
parent 00ee73b294
commit 834c04d739
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/clearml_agent.md
View File

@ -100,7 +100,8 @@ Install ClearML Agent as a system Python package and not in a Python virtual env
Verifying credentials ... Verifying credentials ...
Credentials verified! Credentials verified!
1. Enter your Git username and password. Leave blank for SSH key authentication or when only using public repositories.<br/> 1. Enter your Git username and password. Leave blank for SSH key authentication or when only using public repositories.
This is needed for cloning repositories by the agent. This is needed for cloning repositories by the agent.
Enter git username for repository cloning (leave blank for SSH key authentication): [] Enter git username for repository cloning (leave blank for SSH key authentication): []
@ -110,7 +111,8 @@ Install ClearML Agent as a system Python package and not in a Python virtual env
Git repository cloning will be using user=<username> password=<password> Git repository cloning will be using user=<username> password=<password>
1. Enter an additional artifact repository, or press **Enter** if not required.<br/> 1. Enter an additional artifact repository, or press **Enter** if not required.
This is needed for installing Python packages not found in pypi. This is needed for installing Python packages not found in pypi.
Enter additional artifact repository (extra-index-url) to use when installing python packages (leave blank if not required): Enter additional artifact repository (extra-index-url) to use when installing python packages (leave blank if not required):
@ -580,7 +582,8 @@ It's possible to add the Docker container as the base Docker image to a Task (ex
## Google Colab ## Google Colab
ClearML Agent can run on a [google colab](https://colab.research.google.com/) instance. This helps users to leverage ClearML Agent can run on a [google colab](https://colab.research.google.com/) instance. This helps users to leverage
compute resources provided by google colab and send experiments for execution on it. <br/> compute resources provided by google colab and send experiments for execution on it.
Check out [this](guides/ide/google_colab.md) tutorial on how to run a ClearML Agent on Google Colab! Check out [this](guides/ide/google_colab.md) tutorial on how to run a ClearML Agent on Google Colab!

2
docs/fundamentals/projects.md
View File

@ -19,7 +19,7 @@ the project are executed, the model checkpoints (snapshots) and artifacts are st
## WebApp ## WebApp
Users can create and modify projects, and see project details in the WebApp (see [WebApp Home](../webapp/webapp_home.md)). Users can create and modify projects, and see project details in the WebApp (see [WebApp Home](../webapp/webapp_home.md)).
The project's description can be edited in the [overview](../webapp/webapp_overview.md) page. Each project's experiments, The project's description can be edited in the [overview](../webapp/webapp_overview.md) page. Each project's experiments,
models, and dataviews, can be viewed in the project's [experiments table](../webapp/webapp_exp_table.md), models, and dataviews, can be viewed in the project's [experiments table](../webapp/webapp_exp_table.md),
[models table](../webapp/webapp_model_table.md), and [dataviews table](../hyperdatasets/webapp/webapp_dataviews.md). [models table](../webapp/webapp_model_table.md), and [dataviews table](../hyperdatasets/webapp/webapp_dataviews.md).

3
docs/guides/ide/google_colab.md
View File

@ -3,7 +3,8 @@ title: ClearML Agent on Google Colab
--- ---
[Google Colab](https://colab.research.google.com) is a common development environment for data scientists. It offers a convenient IDE as well as [Google Colab](https://colab.research.google.com) is a common development environment for data scientists. It offers a convenient IDE as well as
compute provided by google.<br/> compute provided by google.
Users can transform a Google Colab instance into an available resource in ClearML using [Clearml Agent](../../clearml_agent.md). Users can transform a Google Colab instance into an available resource in ClearML using [Clearml Agent](../../clearml_agent.md).
In this tutorial, we will go over how to create a ClearML worker node in a Google Colab notebook. Once the worker is up In this tutorial, we will go over how to create a ClearML worker node in a Google Colab notebook. Once the worker is up

11
docs/integrations/storage.md
View File

@ -39,7 +39,7 @@ aws {
# key: "my-access-key" # key: "my-access-key"
# secret: "my-secret-key" # secret: "my-secret-key"
# }, # },
# {
] ]
} }
boto3 { boto3 {
@ -51,6 +51,7 @@ aws {
ClearML also supports [MinIO](https://github.com/minio/minio) by adding this configuration: ClearML also supports [MinIO](https://github.com/minio/minio) by adding this configuration:
``` ```
# {
# host: "my-minio-host:9000" # host: "my-minio-host:9000"
# key: "12345678" # key: "12345678"
# secret: "12345678" # secret: "12345678"
@ -128,8 +129,10 @@ storage {
``` ```
### Direct Access ### Direct Access
By default, all artifacts (Models \ Artifacts \ Datasets) are automatically downloaded to the cache before they're used.<br/> By default, all artifacts (Models / Artifacts / Datasets) are automatically downloaded to the cache before they're used.
Some storage mediums (NFS \ Local storage) allows for direct access,
which means that the code would work with the object where it's originally stored and not downloaded to cache first.<br/> Some storage mediums (NFS / Local storage) allows for direct access,
which means that the code would work with the object where it's originally stored and not downloaded to cache first.
To enable direct access, specify the urls to access directly. To enable direct access, specify the urls to access directly.