diff --git a/docs/clearml_sdk/hpo_sdk.md b/docs/clearml_sdk/hpo_sdk.md index ad39a9f6..6f5e7c2b 100644 --- a/docs/clearml_sdk/hpo_sdk.md +++ b/docs/clearml_sdk/hpo_sdk.md @@ -71,8 +71,8 @@ optimization. from clearml import Task task = Task.init( - project_name='Hyper-Parameter Optimization', - task_name='Automatic Hyper-Parameter Optimization', + project_name='Hyperparameter Optimization', + task_name='Automatic Hyperparameter Optimization', task_type=Task.TaskTypes.optimizer, reuse_last_task_id=False ) diff --git a/docs/deploying_clearml/enterprise_deploy/app_custom.md b/docs/deploying_clearml/enterprise_deploy/app_custom.md index 3b46cc93..5d6833fe 100644 --- a/docs/deploying_clearml/enterprise_deploy/app_custom.md +++ b/docs/deploying_clearml/enterprise_deploy/app_custom.md @@ -61,7 +61,7 @@ The `task` section describes the task to run, containing the following fields: * `branch` - The branch to use * `entry_point` - The python file to run * `working_dir` - The directory to run it from -* `hyperparams` (*Optional*) - A list of the task’s hyper-parameters used by the application, with their default values. There is no need to specify all the parameters here, but it enables summarizing of the parameters that will be targeted by the wizard entries described below, and allows to specify default values to optional parameters appearing in the wizard. +* `hyperparams` (*Optional*) - A list of the task’s hyperparameters used by the application, with their default values. There is no need to specify all the parameters here, but it enables summarizing of the parameters that will be targeted by the wizard entries described below, and allows to specify default values to optional parameters appearing in the wizard. #### Example The `task` section in the simple application example: @@ -276,7 +276,7 @@ The section contains the following information: * hyperparameter * configuration * html - * `text` - For HTML. You can refer to task elements such as hyper-parameters by using `${hyperparams.<section>.<parameter name>.value}` + * `text` - For HTML. You can refer to task elements such as hyperparameters by using `${hyperparams.<section>.<parameter name>.value}` * `metric` - For plot, scalar-histogram, debug-images, scalar - Name of the metric * `variant` - For plot, scalar-histogram, debug-images, scalar - List of variants to display * `key` - For histograms, one of the following: `iter`, `timestamp` or, `iso_time` diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md index de16511f..990bc078 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_compose.md @@ -88,7 +88,7 @@ TCP_PORT_START= TCP_PORT_END= ``` -Edit it according to the following guidelines: +**Configuration Options:** * `PROXY_TAG`: AI Application Gateway proxy tag. The Docker image tag for the proxy component, which needs to be specified during installation. This tag is provided by ClearML to ensure compatibility with the recommended version. * `ROUTER_TAG`: App Gateway Router tag. The Docker image tag for the router component. It defines the specific version diff --git a/docs/deploying_clearml/enterprise_deploy/vpc_aws.md b/docs/deploying_clearml/enterprise_deploy/vpc_aws.md index 37fa7f28..17f048f6 100644 --- a/docs/deploying_clearml/enterprise_deploy/vpc_aws.md +++ b/docs/deploying_clearml/enterprise_deploy/vpc_aws.md @@ -38,7 +38,7 @@ It is recommended to use a VPC with IPv6 enabled for future usage expansion. 1. Create a security group for the main server (`clearml-main`): * Ingress: - * TCP port 10000, from the load balancer's security group + * TCP port 10000 from the load balancer's security group * TCP port 22 from trusted IP addresses. * Egress: All addresses and ports diff --git a/docs/release_notes/sdk/open_source/ver_1_1.md b/docs/release_notes/sdk/open_source/ver_1_1.md index 6deecd44..16bcc190 100644 --- a/docs/release_notes/sdk/open_source/ver_1_1.md +++ b/docs/release_notes/sdk/open_source/ver_1_1.md @@ -203,7 +203,7 @@ title: Version 1.1 - Add support for uploading artifacts with a list of files using `Task.upload_artifcats(name, [Path(), Path()])` - Add missing *clearml-task* parameters `--docker_args`, `--docker_bash_setup_script` and `--output-uri` - Change `CreateAndPopulate` will auto list packages imported but not installed locally -- Add `clearml.task.populate.create_task_from_function()` to create a Task from a function, wrapping function input arguments into hyper-parameter section as kwargs and storing function results as named artifacts +- Add `clearml.task.populate.create_task_from_function()` to create a Task from a function, wrapping function input arguments into hyperparameter section as kwargs and storing function results as named artifacts - Add support for Task serialization (e.g. for pickle) - Add `Task.get_configuration_object_as_dict()` - Add `docker_image` argument to `Task.set_base_docker()` (deprecate `docker_cmd`)