ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-01-31 00:56:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add demo server note to README and number instructions (#470)

Browse Source
This commit is contained in:
pollfly 2021-10-10 10:32:43 +03:00 committed by GitHub
parent d747b2e93e
commit b010f775bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -68,26 +68,30 @@ Instrumenting these components is the **ClearML-server**, see [Self-Hosting](htt
#### [Start using ClearML](https://clear.ml/docs/latest/docs/getting_started/ds/ds_first_steps)
First, sign up for free to the [ClearML Hosted Service](https://app.community.clear.ml) (alternatively, you can set up your own server, see [here](https://clear.ml/docs/latest/docs/deploying_clearml/clearml_server)).
1. Sign up for free to the [ClearML Hosted Service](https://app.community.clear.ml) (alternatively, you can set up your own server, see [here](https://clear.ml/docs/latest/docs/deploying_clearml/clearml_server)).
Install the `clearml` python package:
> **_ClearML Demo Server:_** ClearML no longer uses the demo server by default. To enable the demo server, set the `CLEARML_NO_DEFAULT_SERVER=0`
> environment variable. Credentials aren't needed, but experiments launched to the demo server are public, so make sure not
> to launch sensitive experiments if using the demo server.
```bash
pip install clearml
```
1. Install the `clearml` python package:
Connect the ClearML SDK to the server by [creating credentials](https://app.community.clear.ml/profile), then execute the command
```bash
pip install clearml
```
1. Connect the ClearML SDK to the server by [creating credentials](https://app.community.clear.ml/profile), then execute the command
below and follow the instructions:
```bash
clearml-init
```
```bash
clearml-init
```
Add two lines to your code:
```python
from clearml import Task
task = Task.init(project_name='examples', task_name='hello world')
```
1. Add two lines to your code:
```python
from clearml import Task
task = Task.init(project_name='examples', task_name='hello world')
```
You are done, everything your process outputs is now automagically logged into ClearML.