mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-11 00:58:02 +00:00
Merge branch 'main' of https://github.com/allegroai/clearml-docs into custom
This commit is contained in:
revital
commit
ab43b82267
@ -114,38 +114,40 @@ The following section contains a list of AMI Image IDs per-region for the latest
|
||||
|
||||
### Latest Version
|
||||
|
||||
#### v2.0.0
|
||||
#### v2.1.0
|
||||
|
||||
* **af-south-1** : ami-08a09c37ee67a8890
|
||||
* **ap-east-1** : ami-0e1441e96a36c5b1e
|
||||
* **ap-northeast-1** : ami-0396280fb3103db5b
|
||||
* **ap-northeast-2** : ami-0debccc68a11fbda4
|
||||
* **ap-northeast-3** : ami-092c2a46a6f724357
|
||||
* **ap-south-1** : ami-0bf2b78165336362f
|
||||
* **ap-south-2** : ami-03d5687062ee60cdb
|
||||
* **ap-southeast-1** : ami-08db075cac5d0784c
|
||||
* **ap-southeast-2** : ami-05f9eda027c5fd39f
|
||||
* **ap-southeast-3** : ami-0290df331ef2cd613
|
||||
* **ap-southeast-4** : ami-05f60da502fd0e786
|
||||
* **ap-southeast-5** : ami-0acfcd0ee6dde9b67
|
||||
* **ca-central-1** : ami-037d89da405ce077a
|
||||
* **ca-west-1** : ami-0fafcab2193ab122e
|
||||
* **eu-central-1** : ami-0a32dbec1886efc92
|
||||
* **eu-central-2** : ami-0a009eb3c89f76094
|
||||
* **eu-north-1** : ami-097fc0a160f1167b2
|
||||
* **eu-south-1** : ami-03311467153bb6a36
|
||||
* **eu-south-2** : ami-0c2914dc75d47d03e
|
||||
* **eu-west-1** : ami-02eee33b1e10380e5
|
||||
* **eu-west-2** : ami-069d080cb6a1fda16
|
||||
* **eu-west-3** : ami-004c5d27cfe9ca7a2
|
||||
* **il-central-1** : ami-03cb6cd40ab8a015f
|
||||
* **me-central-1** : ami-06de7b6fab50aacd6
|
||||
* **me-south-1** : ami-0b2bbbff660a06051
|
||||
* **sa-east-1** : ami-0b36127fedeb7a328
|
||||
* **us-east-1** : ami-0635db0627d4d83e6
|
||||
* **us-east-2** : ami-08a8c46eb9907015c
|
||||
* **us-west-1** : ami-0d008037025e788b0
|
||||
* **us-west-2** : ami-091f6b6998367db70
|
||||
* **af-south-1** : ami-0c02f50931989c82c
|
||||
* **ap-east-1** : ami-09f1923e5a508d1ff
|
||||
* **ap-northeast-1** : ami-02ca0c43f301f7302
|
||||
* **ap-northeast-2** : ami-08a17fdd961b11a95
|
||||
* **ap-northeast-3** : ami-001c15a40ce2abfd9
|
||||
* **ap-south-1** : ami-06c84aa5aeb0cee85
|
||||
* **ap-south-2** : ami-0f73b2cb16f6a4c8d
|
||||
* **ap-southeast-1** : ami-02438427c412541bd
|
||||
* **ap-southeast-2** : ami-0ca5327c5659da2d8
|
||||
* **ap-southeast-3** : ami-02c2510f93e9103c2
|
||||
* **ap-southeast-4** : ami-043cc0463fd0d5f65
|
||||
* **ap-southeast-5** : ami-0a89c5a9c39fd05a7
|
||||
* **ap-southeast-7** : ami-09e12423659d893dd
|
||||
* **ca-central-1** : ami-0c902f35c96b30c39
|
||||
* **ca-west-1** : ami-0f5ec5964e548adfd
|
||||
* **eu-central-1** : ami-0879367e77eb2f09f
|
||||
* **eu-central-2** : ami-096caaa4aada8a7d8
|
||||
* **eu-north-1** : ami-0800c04d58a0192c6
|
||||
* **eu-south-1** : ami-0b95afb1fa7fb718c
|
||||
* **eu-south-2** : ami-0393bdf1fb5212db5
|
||||
* **eu-west-1** : ami-0faee29c9e77fd277
|
||||
* **eu-west-2** : ami-0e1a7b05c74d47a17
|
||||
* **eu-west-3** : ami-0927e68e0d333890e
|
||||
* **il-central-1** : ami-0282774a5d6f5bbef
|
||||
* **me-central-1** : ami-0245376f5c1690b9d
|
||||
* **me-south-1** : ami-0df5d9605c6bcbd87
|
||||
* **mx-central-1** : ami-0a39df8700027a475
|
||||
* **sa-east-1** : ami-07e28e8e282e8fc34
|
||||
* **us-east-1** : ami-066f2e1182971cd2e
|
||||
* **us-east-2** : ami-007206d639ecc9430
|
||||
* **us-west-1** : ami-057d8ca86daa6f675
|
||||
* **us-west-2** : ami-06d802321b6a20774
|
||||
|
||||
## Next Step
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ The ClearML Agent enables scheduling and executing distributed experiments on a
|
||||
|
||||
- The worker environment must be able to access the ClearML Server over the same network.
|
||||
- Helm token to access `clearml-enterprise` Helm chart repo
|
||||
- To support **GPU** queues, you must deploy the **NVIDIA GPU Operator** on your Kubernetes cluster. For more information, see [GPU Operator](extra_configs/gpu_operator.md).
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ It can only configure access for ClearML Tasks within its own namespace.
|
||||
|
||||
### Login
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username <GITHUB_TOKEN> --password <GITHUB_TOKEN>
|
||||
```
|
||||
|
||||
@ -80,7 +80,7 @@ tcpSession:
|
||||
|
||||
The full list of supported configuration is available with the command:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm show readme clearml-enterprise/clearml-enterprise-app-gateway
|
||||
```
|
||||
|
||||
@ -88,7 +88,7 @@ helm show readme clearml-enterprise/clearml-enterprise-app-gateway
|
||||
|
||||
To install the App Gateway component via Helm use the following command:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm upgrade --install <RELEASE_NAME> -n <WORKLOAD_NAMESPACE> clearml-enterprise/clearml-enterprise-app-gateway --version <CHART_VERSION> -f clearml-app-gateway-values.override.yaml
|
||||
```
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ devicePlugin:
|
||||
|
||||
Install the `gpu-operator`:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm install -n gpu-operator gpu-operator nvidia/gpu-operator --create-namespace -f gpu-operator.override.yaml
|
||||
```
|
||||
|
||||
|
||||
@ -203,7 +203,7 @@ This label is used by the CFGI to assign the correct portion of GPU resources to
|
||||
Starting from version 1.3.0, there is no need to specify the resources field. You only need to set the labels:
|
||||
|
||||
|
||||
``` yaml
|
||||
```yaml
|
||||
agentk8sglue:
|
||||
createQueues: true
|
||||
queues:
|
||||
|
||||
@ -46,12 +46,12 @@ For optimal performance, a Kubernetes cluster with at least 3 nodes is recommend
|
||||
|
||||
Add the ClearML Helm repository:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm repo add clearml-enterprise https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages --username <HELM_REPO_TOKEN> --password <HELM_REPO_TOKEN>
|
||||
```
|
||||
|
||||
Update the local repository:
|
||||
``` bash
|
||||
```bash
|
||||
helm repo update
|
||||
```
|
||||
|
||||
@ -64,7 +64,7 @@ In the following configuration, replace the `<BASE_DOMAIN>` placeholders with a
|
||||
pointing to the cluster's Ingress Controller. This will be the base domain for reaching your ClearML installation.
|
||||
:::
|
||||
|
||||
``` yaml
|
||||
```yaml
|
||||
imageCredentials:
|
||||
password: "<CLEARML_DOCKERHUB_TOKEN>"
|
||||
clearml:
|
||||
@ -95,10 +95,18 @@ clearmlApplications:
|
||||
|
||||
Install the ClearML Enterprise Helm chart using the previous values override file.
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
helm upgrade -i -n clearml clearml clearml-enterprise/clearml-enterprise --create-namespace -f clearml-values.override.yaml
|
||||
```
|
||||
|
||||
### Applications Installation
|
||||
ClearML Applications are plugins that extend the functionality of the ClearML Enterprise Server. They enable users
|
||||
to manage ML workloads and automate recurring workflows--no code required
|
||||
|
||||
Applications are installed on top of the ClearML Server and are provided by the ClearML team.
|
||||
|
||||
For more information, see [ClearML Applications](extra_configs/apps.md).
|
||||
|
||||
## Additional Configuration Options
|
||||
|
||||
:::note
|
||||
@ -118,7 +126,7 @@ Kubernetes.
|
||||
|
||||
If you need to define your own credentials to be used instead, replace the default key and secret values in `clearml-values.override.yaml`.
|
||||
|
||||
``` yaml
|
||||
```yaml
|
||||
clearml:
|
||||
# Replace the following values to use custom internal credentials.
|
||||
apiserverKey: ""
|
||||
@ -132,7 +140,7 @@ clearml:
|
||||
|
||||
In a shell, if `openssl` is installed, you can use this simple command to generate random strings suitable as keys and secrets:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
openssl rand -hex 16
|
||||
```
|
||||
|
||||
@ -143,7 +151,7 @@ installations. This is an optional step in case the SSO (Identity provider) conf
|
||||
|
||||
Please note that this setup is not ideal for multi-tenant setups as fixed users will only be associated with the default tenant.
|
||||
|
||||
``` yaml
|
||||
```yaml
|
||||
apiserver:
|
||||
additionalConfigs:
|
||||
apiserver.conf: |
|
||||
|
||||
@ -37,8 +37,8 @@ apiserver:
|
||||
value: "true"
|
||||
```
|
||||
|
||||
These settings configure the **supervisor**, an administrative user belonging to a designated supervisor company.
|
||||
Admins in the supervisor company can view the resource usage dashboards across all tenants.
|
||||
These values configure a **supervisor** user, an administrator in a designated supervisor tenant. These users can access cross-tenant information, and
|
||||
specifically view an aggregate resource dashboard for all tenants.
|
||||
|
||||
The `<SUPERVISOR_USER_KEY>` and `<SUPERVISOR_USER_SECRET>` can be used to log in as the
|
||||
supervisor user from the ClearML Web UI via `app.<BASE_DOMAIN>`.
|
||||
@ -475,7 +475,7 @@ The following features can be assigned to groups via the `features` configuratio
|
||||
| `sso_management` | Enables the SSO (Single Sign-On) configuration wizard. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `service_users` | Enables support for creating and managing service accounts (API keys). | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `resource_policy` | Enables the [Resource Policies](../../webapp/resource_policies.md) feature. | May default to a trial feature if not explicitly enabled. |
|
||||
| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endoints.md) feature. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `model_serving` | Enables access to the [Model Endpoints](../../webapp/webapp_model_endpoints.md) feature. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `show_dashboard` | Makes the "Dashboard" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `show_model_view` | Makes the "Models" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
| `show_projects` | Makes the "Projects" menu item visible in the UI sidebar. | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
|
||||
|
||||
@ -12,7 +12,7 @@ on a remote or local machine, from a remote repository and your local machine.
|
||||
|
||||
### Executing Code from a Remote Repository
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
clearml-task --project keras_examples --name remote_test --repo https://github.com/clearml/events.git --branch master --script /webinar-0620/keras_mnist.py --args batch_size=64 epochs=1 --queue default
|
||||
```
|
||||
|
||||
|
||||
52
docs/release_notes/clearml_server/open_source/ver_2_1.md
Normal file
52
docs/release_notes/clearml_server/open_source/ver_2_1.md
Normal file
@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Version 2.1
|
||||
---
|
||||
|
||||
### ClearML Server 2.1.0
|
||||
|
||||
**New Features**
|
||||
* New UI task creation options
|
||||
* Support bash as well as Python scripts
|
||||
* Support file upload
|
||||
* Add per-project UI scalar view configuration ([ClearML GitHub issue #1377](https://github.com/clearml/clearml/issues/1377))
|
||||
* Add support for custom x-axis label in UI Task scalars
|
||||
* Add global search bar to all UI pages
|
||||
* Add filter to UI Model Endpoints table
|
||||
* Add clicking UI breadcrumbs project name of full-screen task opens the project's task table ([ClearML GitHub issue #1376](https://github.com/clearml/clearml/issues/1376))
|
||||
* Improve UI task debug sample viewer:
|
||||
* Zoom setting persists when navigating between samples ([ClearML GitHub issue #1390](https://github.com/clearml/clearml/issues/1390))
|
||||
* Zoom focuses on cursor position
|
||||
|
||||
**Bug Fixes**
|
||||
* Fix EMA smoothing in UI scalars is incorrect in first data point ([ClearML Web GitHub issue #101](https://github.com/clearml/clearml-web/issues/101))
|
||||
* Improve UI scalar smoothing algorithms (ClearML Web GitHub issues [#101](https://github.com/clearml/clearml-web/issues/101),
|
||||
[#102](https://github.com/clearml/clearml-web/issues/102), [#103](https://github.com/clearml/clearml-web/issues/103))
|
||||
* Fix UI Plots does not respect plotly `aspectmode` ([ClearML GitHub issue #1389](https://github.com/clearml/clearml/issues/1389))
|
||||
* Fix ctrl-f does not open a search bar in UI editor modals ([ClearML Web GitHub issue #99](https://github.com/clearml/clearml-web/issues/99))
|
||||
* Fix UI original series of smoothed plots barely visible in dark mode ([ClearML Server GitHub issue #270](https://github.com/clearml/clearml-server/issues/270))
|
||||
* Fix webserver configuration environment variables don't load with single-quoted strings ([ClearML Server GitHub issue #271](https://github.com/clearml/clearml-server/issues/271))
|
||||
* Fix next/previous function not working in UI model plots in full-screen
|
||||
* Fix UI pipeline "Preview" tab sometimes displays "Failed to get plot charts" error
|
||||
* Fix image plots sometimes not rendered in UI
|
||||
* Fix UI plot legend state is not persistent
|
||||
* Fix parameter graph color is not persistent between plots in UI Model Endpoint
|
||||
* Fix UI Pipeline Stage Info modal displays broken link
|
||||
* Fix UI Model table tag filter displaying unnecessary artifacts after excluding tag
|
||||
* Fix "All" tag filter not working in UI model selection modal in comparison pages
|
||||
* Fix UI task table displaying incorrect footer sometimes
|
||||
* Fix task status not updating in UI task comparison page
|
||||
* Fix manual refresh function sometimes does not work in UI task full screen view
|
||||
* Fix recently modified reports not displayed in UI "Recent Reports"
|
||||
* Fix UI task plot zoom not maintained between full screen and regular view ([ClearML Web GitHub issue #106](https://github.com/clearml/clearml-web/issues/106))
|
||||
* Fix UI scalar graph colors sometimes difficult to see in light mode ([ClearML Web GitHub issue #104](https://github.com/clearml/clearml-web/issues/104))
|
||||
* Fix UI task comparison's metric search bar in Scalars tab is case-sensitive
|
||||
* Fix UI task configuration long loading time
|
||||
* Fix embedded UI task comparison parallel coordinates plot does not display plot legend
|
||||
* Fix UI embedded plot colors do not change upon UI theme change
|
||||
* Fix deleting a parameter in the UI task creation modal incorrectly removes another parameter
|
||||
* Add support for comparing tasks from specific project in UI Reports customized embed queries
|
||||
* Fix clicking "Details" view causes UI Model data to disappear
|
||||
* Fix UI scalars hide/unhide function sometimes doesn't work for single-variant metrics
|
||||
* Fix maximizing UI scalar plot raises an error
|
||||
* Fix clicking on task in UI Model lineage navigates to incorrect page
|
||||
* Fix UI breadcrumbs sometimes does not display project name
|
||||
@ -309,7 +309,7 @@ Scalar graph view (<img src="/docs/latest/icons/ico-charts-view.svg" alt="Graph
|
||||
shows scalar series plotted as a time series line chart. By default, a single plot is shown for each scalar metric,
|
||||
with all variants overlaid within.
|
||||
|
||||
The series are sub-sampled for
|
||||
The series are subsampled for
|
||||
display efficiency. For high resolution, view a series in full screen mode by hovering over the graph and clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-md space-sm" />.
|
||||
|
||||
:::info Full Screen Refresh
|
||||
|
||||
@ -138,7 +138,7 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
label: 'Release Notes',
|
||||
to: '/docs/release_notes/clearml_server/open_source/ver_2_0',
|
||||
to: '/docs/release_notes/clearml_server/open_source/ver_2_1',
|
||||
activeBaseRegex: '^/docs/latest/docs/release_notes/',
|
||||
},
|
||||
|
||||
@ -167,6 +167,12 @@ module.exports = {
|
||||
className: 'header-ico header-ico--twitter',
|
||||
'aria-label': 'Twitter',
|
||||
},
|
||||
{
|
||||
href: 'https://www.linkedin.com/company/clearml',
|
||||
position: 'right',
|
||||
className: 'header-ico header-ico--linkedin',
|
||||
'aria-label': 'LinkedIn',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/clearml/clearml',
|
||||
position: 'right',
|
||||
@ -197,6 +203,10 @@ module.exports = {
|
||||
label: 'Stack Overflow',
|
||||
href: 'https://stackoverflow.com/questions/tagged/clearml',
|
||||
},
|
||||
{
|
||||
label: 'LinkedIn',
|
||||
href: 'https://www.linkedin.com/company/clearml',
|
||||
},
|
||||
// {
|
||||
// html: `
|
||||
// <a href="https://twitter.com/clearmlapp" target="_blank" rel="noreferrer noopener" aria-label="Twitter">
|
||||
|
||||
@ -290,9 +290,10 @@ module.exports = {
|
||||
{
|
||||
'Open Source':
|
||||
[
|
||||
'release_notes/clearml_server/open_source/ver_2_0',
|
||||
'release_notes/clearml_server/open_source/ver_2_1',
|
||||
{
|
||||
'Older Versions': [
|
||||
'release_notes/clearml_server/open_source/ver_2_0',
|
||||
'release_notes/clearml_server/open_source/ver_1_17', 'release_notes/clearml_server/open_source/ver_1_16',
|
||||
'release_notes/clearml_server/open_source/ver_1_15', 'release_notes/clearml_server/open_source/ver_1_14',
|
||||
'release_notes/clearml_server/open_source/ver_1_13', 'release_notes/clearml_server/open_source/ver_1_12',
|
||||
|
||||
@ -290,6 +290,9 @@ html[data-theme="light"] .hero .button.button--primary{
|
||||
.header-ico--slack {
|
||||
background-image: url('/img/ico-slack.svg');
|
||||
}
|
||||
.header-ico--linkedin {
|
||||
background-image: url('/img/ico-linkedin.svg');
|
||||
}
|
||||
.header-ico {
|
||||
width:24px;
|
||||
height:24px;
|
||||
@ -444,6 +447,9 @@ html[data-theme="dark"] .navbar-sidebar .menu__link.header-ico--slack:before {
|
||||
.navbar-sidebar .menu__link.header-ico--youtube:hover {
|
||||
background: url('/img/ico-youtube.svg') no-repeat center;
|
||||
}
|
||||
.navbar-sidebar .menu__link.header-ico--linkedin:hover {
|
||||
background: url('/img/ico-linkedin.svg') no-repeat center;
|
||||
}
|
||||
|
||||
.menu__link.header-ico {
|
||||
margin: 1rem 0 0 0.5rem;
|
||||
@ -569,10 +575,16 @@ html[data-theme="dark"] input[class^="searchQueryInput"] {
|
||||
background: url('/img/ico-stackoverflow.svg') no-repeat left center;
|
||||
background-size: 1rem;
|
||||
}
|
||||
.footer__link-item[href*="linkedin"] {
|
||||
padding-left: 1.4rem;
|
||||
background: url('/img/ico-linkedin.svg') no-repeat left center;
|
||||
background-size: 1rem;
|
||||
}
|
||||
|
||||
html[data-theme="light"] .footer__link-item[href*="slack"],
|
||||
html[data-theme="light"] .footer__link-item[href*="youtube"],
|
||||
html[data-theme="light"] .footer__link-item[href*="twitter"],
|
||||
html[data-theme="light"] .footer__link-item[href*="linkedin"],
|
||||
html[data-theme="light"] .footer__link-item[href*="stackoverflow"] {
|
||||
filter: brightness(0.5);
|
||||
}
|
||||
|
||||
3
static/img/ico-linkedin.svg
Normal file
3
static/img/ico-linkedin.svg
Normal file
@ -0,0 +1,3 @@
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M19.7773 2C21.0046 2 22 2.99536 22 4.22266V19.7773C22 21.0046 21.0046 22 19.7773 22H4.22266C2.99536 22 2 21.0046 2 19.7773V4.22266C2 2.99536 2.99536 2 4.22266 2H19.7773ZM5.06445 19.2227H8.04688V9.59277H5.06445V19.2227ZM15.7178 9.29883C13.6743 9.29883 12.8135 10.8896 12.8135 10.8896V9.59277H9.9541V19.2227H12.8135V14.167C12.8136 12.8127 13.4376 12.0068 14.6309 12.0068C15.7277 12.0069 16.2538 12.7813 16.2539 14.167V19.2227H19.2227V13.125C19.2225 10.5457 17.76 9.29899 15.7178 9.29883ZM6.54102 4.77734C5.567 4.7776 4.77736 5.57357 4.77734 6.55469C4.77734 7.53582 5.56698 8.33178 6.54102 8.33203C7.51526 8.33203 8.30469 7.53598 8.30469 6.55469C8.30467 5.57341 7.51525 4.77734 6.54102 4.77734Z" fill="#F6F6F6"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 862 B |
Loading…
Reference in New Issue
Block a user