diff --git a/docs/clearml_sdk/apiclient_sdk.md b/docs/clearml_sdk/apiclient_sdk.md index ad2a6bd4..afde54f2 100644 --- a/docs/clearml_sdk/apiclient_sdk.md +++ b/docs/clearml_sdk/apiclient_sdk.md @@ -17,7 +17,7 @@ Through an `APIClient` instance, you can access ClearML’s REST API services: `APIClient` makes the ClearML Server’s REST API endpoints available as Python methods. -To use `APIClient`, create an instance of it then call the method corresponding to the desired REST API endpoints, with +To use `APIClient`, create an instance of it then call the method corresponding to the desired REST API endpoint, with its respective parameters as described in the [REST API reference page](../references/api/index.md). For example, the [`POST/ projects.get_all`](../references/api/projects.md#post-projectsget_all) call returns all projects diff --git a/docs/faq.md b/docs/faq.md index 92d5e415..e2167a1d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -834,7 +834,7 @@ Set the OS environment variable `CLEARML_LOG_ENVIRONMENT` with the variables you **I run my script, but my experiment is not in the ClearML Hosted Service Web UI. How do I fix this?** -If you joined the ClearML Hosted Service and run a script, but your experiment does not appear in Web UI, you may not have configured ClearML for the hosted service. Run the ClearML setup wizard. It will request your hosted service ClearML credentials and create the ClearML configuration you need. +If you joined the ClearML Hosted Service and ran a script, but your experiment does not appear in Web UI, you may not have configured ClearML for the hosted service. Run the ClearML setup wizard. It will request your hosted service ClearML credentials and create the ClearML configuration you need. pip install clearml diff --git a/docs/pipelines/pipelines_sdk_tasks.md b/docs/pipelines/pipelines_sdk_tasks.md index 20d5b614..1bd7c03b 100644 --- a/docs/pipelines/pipelines_sdk_tasks.md +++ b/docs/pipelines/pipelines_sdk_tasks.md @@ -48,11 +48,11 @@ You can connect configuration dictionaries or files to a pipeline controller usi [PipelineController.connect_configuration](../references/sdk/automation_controller_pipelinecontroller.md#connect_configuration) method by providing the configuration object, or file path. -For files, call `connect_configuration()` before reading the configuration file. If it's a local files, input a relative +For files, call `connect_configuration()` before reading the configuration file. If it's a local file, input a relative path. ```python -config_file = pipe.connect_configuration(configuration=config_file_path, name="My Configuration", description="configuraiton for pipeline") +config_file = pipe.connect_configuration(configuration=config_file_path, name="My Configuration", description="configuration for pipeline") my_params = json.load(open(config_file,'rt')) ```