mirror of
https://github.com/clearml/clearml-docs
synced 2025-04-02 12:21:08 +00:00
Small edits (#171)
This commit is contained in:
pollfly
GitHub
parent
9aa4bca2ab
commit
9727045603
@ -8,16 +8,16 @@ This documentation page applies to deploying your own open source ClearML Server
|
||||
|
||||
Deploy the **ClearML Server** in Linux or macOS using the pre-built Docker image.
|
||||
|
||||
For **ClearML** docker images, including previous versions, see [https://hub.docker.com/r/allegroai/clearml](https://hub.docker.com/r/allegroai/clearml).
|
||||
However, pulling the **ClearML** Docker image directly is not required. We provide a docker-compose YAML file that does this.
|
||||
For ClearML docker images, including previous versions, see [https://hub.docker.com/r/allegroai/clearml](https://hub.docker.com/r/allegroai/clearml).
|
||||
However, pulling the ClearML Docker image directly is not required. We provide a docker-compose YAML file that does this.
|
||||
The docker-compose file is included in the instructions on this page.
|
||||
|
||||
For information about upgrading **ClearML Server** in Linux or macOS, see [here](upgrade_server_linux_mac.md)
|
||||
For information about upgrading ClearML Server in Linux or macOS, see [here](upgrade_server_linux_mac.md)
|
||||
|
||||
:::important
|
||||
If **ClearML Server** is being reinstalled, we recommend clearing browser cookies for **ClearML Server**. For example,
|
||||
If ClearML Server is being reinstalled, we recommend clearing browser cookies for ClearML Server. For example,
|
||||
for Firefox, go to Developer Tools > Storage > Cookies, and for Chrome, go to Developer Tools > Application > Cookies,
|
||||
and delete all cookies under the **ClearML Server** URL.
|
||||
and delete all cookies under the ClearML Server URL.
|
||||
:::
|
||||
|
||||
|
||||
@ -28,17 +28,17 @@ For Linux users only:
|
||||
* Linux distribution must support Docker. For more information, see this [explanation](https://docs.docker.com/engine/install/) in the Docker documentation.
|
||||
* Be logged in as a user with `sudo` privileges.
|
||||
* Use `bash` for all command-line instructions in this installation.
|
||||
* The ports `8080`, `8081`, and `8008` must be available for the **ClearML Server** services.
|
||||
* The ports `8080`, `8081`, and `8008` must be available for the ClearML Server services.
|
||||
|
||||
## Deploying
|
||||
|
||||
|
||||
:::warning
|
||||
By default, **ClearML Server** launches with unrestricted access. To restrict **ClearML Server** access, follow the
|
||||
By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the
|
||||
instructions in the [Security](clearml_server_security.md) page.
|
||||
:::
|
||||
|
||||
**To launch **ClearML Server** on Linux or macOS:**
|
||||
**To launch ClearML Server on Linux or macOS:**
|
||||
|
||||
1. Install Docker. The instructions depend upon the operating system:
|
||||
|
||||
@ -85,7 +85,7 @@ instructions in the [Security](clearml_server_security.md) page.
|
||||
screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
|
||||
sysctl -w vm.max_map_count=262144
|
||||
|
||||
1. Remove any previous installation of **ClearML Server**.
|
||||
1. Remove any previous installation of ClearML Server.
|
||||
|
||||
**This clears all existing ClearML SDK databases.**
|
||||
|
||||
@ -119,11 +119,11 @@ instructions in the [Security](clearml_server_security.md) page.
|
||||
|
||||
sudo chown -R $(whoami):staff /opt/clearml
|
||||
|
||||
1. Download the **ClearML Server** docker-compose YAML file.
|
||||
1. Download the ClearML Server docker-compose YAML file.
|
||||
|
||||
sudo curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
|
||||
|
||||
1. For Linux only, configure the **ClearML Agent Services**. If `CLEARML_HOST_IP` is not provided, then **ClearML Agent Services** uses the external public address of the **ClearML Server**. If `CLEARML_AGENT_GIT_USER` / `CLEARML_AGENT_GIT_PASS` are not provided, then **ClearML Agent Services** can't access any private repositories for running service tasks.
|
||||
1. For Linux only, configure the **ClearML Agent Services**. If `CLEARML_HOST_IP` is not provided, then ClearML Agent Services uses the external public address of the **ClearML Server**. If `CLEARML_AGENT_GIT_USER` / `CLEARML_AGENT_GIT_PASS` are not provided, then **ClearML Agent Services** can't access any private repositories for running service tasks.
|
||||
|
||||
export CLEARML_HOST_IP=server_host_ip_here
|
||||
export CLEARML_AGENT_GIT_USER=git_username_here
|
||||
@ -137,7 +137,7 @@ The server is now running on [http://localhost:8080](http://localhost:8080).
|
||||
|
||||
## Port Mapping
|
||||
|
||||
After deploying **ClearML Server**, the services expose the following ports:
|
||||
After deploying ClearML Server, the services expose the following ports:
|
||||
|
||||
* Web server on port `8080`
|
||||
* API server on port `8008`
|
||||
|
||||
@ -3,7 +3,7 @@ title: PyTorch MNIST
|
||||
---
|
||||
|
||||
The [pytorch_mnist.py](https://github.com/allegroai/clearml/blob/master/examples/frameworks/pytorch/pytorch_mnist.py) example
|
||||
demonstrates the integration of **ClearML** into code that uses PyTorch.
|
||||
demonstrates the integration of ClearML into code that uses PyTorch.
|
||||
|
||||
The example script does the following:
|
||||
* Trains a simple deep neural network on the PyTorch built-in [MNIST](https://pytorch.org/vision/stable/datasets.html#mnist)
|
||||
|
||||
@ -30,19 +30,20 @@ and running, users can send Tasks to be executed on the Google Colab's HW.
|
||||
This environment variable makes Matplotlib work in headless mode, so it won't output graphs to the screen.
|
||||
|
||||
1. Create new credentials.
|
||||
Go to your **profile** in the [ClearML WebApp](https://app.clear.ml). Under the **WORKSPACES** section,
|
||||
go to **App Credentials**, click **+ Create new credentials**, and copy the information that pops up.
|
||||
Go to your [**Settings**](https://app.clear.ml/settings/workspace-configuration) page > **WORKSPACE** section.
|
||||
Under **App Credentials**, click **+ Create new credentials**, and copy the information that pops up.
|
||||
|
||||
1. Set the credentials.
|
||||
In the third cell, enter your own credentials:
|
||||
```python
|
||||
from clearml import Task
|
||||
|
||||
Task.set_credentials(api_host="https://api.community.clear.ml",
|
||||
web_host="https://app.community.clear.ml",
|
||||
files_host="https://files.community.clear.ml",
|
||||
key='6ZHX9UQMYL874A1NE8',
|
||||
secret='=2h6#%@Y&m*tC!VLEXq&JI7QhZPKuJfbaYD4!uUk(t7=9ENv'
|
||||
Task.set_credentials(
|
||||
api_host="https://api.community.clear.ml",
|
||||
web_host="https://app.community.clear.ml",
|
||||
files_host="https://files.community.clear.ml",
|
||||
key='6ZHX9UQMYL874A1NE8',
|
||||
secret='=2h6#%@Y&m*tC!VLEXq&JI7QhZPKuJfbaYD4!uUk(t7=9ENv'
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
@ -196,7 +196,12 @@ logger.report_media('audio', 'pink panther', iteration=1, local_path=audio_local
|
||||
### HTML
|
||||
|
||||
```python
|
||||
logger.report_media("html", "url_html", iteration=1, url="https://clear.ml/docs/latest/docs/index.html")
|
||||
logger.report_media(
|
||||
"html",
|
||||
"url_html",
|
||||
iteration=1,
|
||||
url="https://clear.ml/docs/latest/docs/index.html"
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
|
||||
@ -21,7 +21,12 @@ See the example script's [report_html_url](https://github.com/allegroai/clearml/
|
||||
function, which reports the ClearML documentation's home page.
|
||||
|
||||
```python
|
||||
Logger.current_logger().report_media("html", "url_html", iteration=iteration, url="https://clear.ml/docs/latest/docs/index.html")
|
||||
Logger.current_logger().report_media(
|
||||
"html",
|
||||
"url_html",
|
||||
iteration=iteration,
|
||||
url="https://clear.ml/docs/latest/docs/index.html"
|
||||
)
|
||||
```
|
||||
|
||||
## Reporting HTML Local Files
|
||||
|
||||
Loading…
Reference in New Issue
Block a user