Fix links (#145)

This commit is contained in:
pollfly 2021-12-28 12:52:15 +02:00 committed by GitHub
parent 110abddd13
commit 4003bff771
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 13 additions and 13 deletions

View File

@ -146,8 +146,8 @@ The Task must be connected to a git repository, since currently single script de
| `--remote-gateway` | Specify a gateway IP to pass to the interactive session, if an external address needs to be accessed | `none`|
| `--base-task-id` | Pass the ID of a task that will become the base task, so the session will use its configurations | `none` or the previously entered base task |
| `--disable-keepalive` | Disable transparent proxy that keep sockets alive to maintain the connection to the remote resource | `false` |
| `--queue-excluded-tag` | The queue option list will exclude queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/endpoints#post-queuescreate) API call | `none` |
| `--queue-include-tag` | The queue option list will include only queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/endpoints#post-queuescreate) API call | `none` |
| `--queue-excluded-tag` | The queue option list will exclude queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/queues.md#post-queuescreate) API call | `none` |
| `--queue-include-tag` | The queue option list will include only queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/queues.md#post-queuescreate) API call | `none` |
| `--skip-docker-network` | Pass the `--network host` flag to the Docker that is launching the remote session. See [Networking using the host network](https://docs.docker.com/network/network-tutorial-host/) | `false`|
| `--username`| Set your own SSH username for the interactive session | `root` or a previously used username |
| `--password`| Set your own SSH password for the interactive session | A randomly generated password or a previously used one |

View File

@ -56,7 +56,7 @@ help maintainers reproduce the problem:
* **Provide the specific environment setup.** Include the ``pip freeze`` output, specific environment variables, Python version, and other relevant information.
* **Provide specific examples to demonstrate the steps.** Include links to files or GitHub projects, or copy / paste snippets which you use in those examples.
* **If you are reporting any ClearML crash,** include a crash report with a stack trace from the operating system. Make
sure to add the crash report in the issue and place it in a [code block](https://help.github.com/en/articles/getting-started-with-writing-and-formatting-on-github#multiple-lines),
sure to add the crash report in the issue and place it in a [code block](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks),
a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), or just put it in
a [gist](https://gist.github.com) (and provide a link to that gist).
* **Describe the behavior you observed after following the steps** and the exact problem with that behavior.
@ -74,7 +74,7 @@ Enhancement suggestions are tracked as GitHub issues. After you determine which
* **A clear and descriptive title** for the issue to identify the suggestion.
* **A step-by-step description of the suggested enhancement** in as much detail as possible.
* **Specific examples to demonstrate the steps.** Include copy / pasteable snippets which you use in those examples as
[Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
[Markdown code blocks](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
* **Describe the current behavior and explain which behavior you expected to see instead and why.**
* **Include screenshots or animated GIFs** that help you demonstrate the steps or point out the part of ClearML which the
suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap) to record GIFs on macOS and Windows, and

View File

@ -283,7 +283,7 @@ to reproduce. You can see uncommitted changes in the ClearML Web UI, in the EXEC
**I do not use argparse for hyperparameters. Do you have a solution?** <a id="dont-want-argparser"></a>
Yes! ClearML supports connecting hyperparameter dictionaries to experiments, using the [Task.connect](fundamentals/hyperparameters#connecting-objects) method.
Yes! ClearML supports connecting hyperparameter dictionaries to experiments, using the [Task.connect](references/sdk/task.md#connect) method.
For example, to log the hyperparameters `learning_rate`, `batch_size`, `display_step`,
`model_path`, `n_hidden_1`, and `n_hidden_2`:

View File

@ -361,7 +361,7 @@ The remote mode is the pipeline controller's default mode. In this mode, the pip
Example:
```python
if __name__ == '__main__':
executing_pipeline(pickle_url='https://exaple.com/iris_dataset.pkl')
executing_pipeline(pickle_url='https://example.com/iris_dataset.pkl')
print('pipeline completed')
```

View File

@ -282,7 +282,7 @@ cloned = Task.clone(
A cloned Task starts in [draft](#task-states) mode, so its Task configurations can be edited (see
[Task.set_parameters](../references/sdk/task.md#set_parameters)).
Once a Task is modified, launch it by pushing it into an execution queue, then a [ClearML Agent](../clearml_agent) will pull
Once a Task is modified, launch it by pushing it into an execution queue, then a [ClearML Agent](../clearml_agent.md) will pull
it from the queue and execute the Task.
```python

View File

@ -56,7 +56,7 @@ ClearML results page: https://community/projects/4043a1657f374e9298649c6ba72ad23
**Thats it!** You are done integrating ClearML with your code :)
Now, [command-line arguments](../../fundamentals/hyperparameters.md#argument-parser), [console output](../../fundamentals/logger#types-of-logged-results) as well as Tensorboard and Matplotlib will automatically be logged in the UI under the created Task.
Now, [command-line arguments](../../fundamentals/hyperparameters.md#command-line-parsing), [console output](../../fundamentals/logger#types-of-logged-results) as well as Tensorboard and Matplotlib will automatically be logged in the UI under the created Task.
<br/>
Sit back, relax, and watch your models converge :) or continue to see what else can be done with ClearML [here](ds_second_steps.md).

View File

@ -2,7 +2,7 @@
title: Dataviews Table
---
[Dataviews](../dataviews.mda) appear in the same Project as the experiment that stored the Dataview in the ClearML Enterprise platform,
[Dataviews](../dataviews.md) appear in the same Project as the experiment that stored the Dataview in the ClearML Enterprise platform,
as well as the **DATAVIEWS** tab in the **All Projects** page.
The **Dataviews table** is a [customizable](#customizing-the-dataviews-table) list of Dataviews associated with a project.

View File

@ -11,7 +11,7 @@ including:
* [General information](#general-information) - Information about the experiment, for example: the experiment start, create, and last update times and dates, user creating the experiment, and its description.
* [Console](#console) - stdout, stderr, output to the console from libraries, and **ClearML** explicit reporting.
* [Scalars](#scalars) - Metric plots.
* [Plots](#other-plots) - Other plots and data, for example: Matplotlib, Plotly, and **ClearML** explicit reporting.
* [Plots](#plots) - Other plots and data, for example: Matplotlib, Plotly, and **ClearML** explicit reporting.
* [Debug samples](#debug-samples) - Images, audio, video, and HTML.
## Viewing Modes
@ -29,7 +29,7 @@ table / full screen**.
### Info Panel
The info panel keeps the experiment table in view so that [experiment actions](webapp_exp_table#experiment-actions)
The info panel keeps the experiment table in view so that [experiment actions](webapp_exp_table.md#experiment-actions)
can be performed from the table (as well as the menu in the info panel).
<details className="cml-expansion-panel screenshot">

View File

@ -71,7 +71,7 @@ Select source code by changing any of the following:
#### Base Docker Image
Select a pre-configured Docker that **ClearML Agent** will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#building-docker-containers)).
Select a pre-configured Docker that **ClearML Agent** will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container)).
**To add, change, or delete a base Docker image:**
@ -99,7 +99,7 @@ and formats for specifying locations include:
Also set the output destination for artifacts in code (see the `output_uri` parameter of the
[Task.init](../references/sdk/task.md#taskinit)
method), and in the **ClearML** configuration file
for all experiments (see [default_output_uri](../configs/clearml_conf#config_default_output_uri)
for all experiments (see [default_output_uri](../configs/clearml_conf.md#config_default_output_uri)
on the **ClearML** Configuration Reference page).
:::