An Estimator wraps run configuration information for specifying details
of executing an R script. Running an Estimator experiment
submit_experiment()) will return a
ScriptRun object and
execute your training script on the specified compute target.
To define the environment to use for training, you can either directly
provide the environment-related parameters (e.g.
estimator(), or you can provide an
Environment object to the
environment parameter. For more information
on the predefined Docker images that are used for training if
custom_docker_image is not specified, see the documentation
estimator(source_directory, compute_target = NULL, vm_size = NULL, vm_priority = NULL, entry_script = NULL, script_params = NULL, cran_packages = NULL, github_packages = NULL, custom_url_packages = NULL, custom_docker_image = NULL, image_registry_details = NULL, use_gpu = FALSE, environment_variables = NULL, shm_size = NULL, max_run_duration_seconds = NULL, environment = NULL)
A string of the local directory containing experiment configuration and code files needed for the training job.
A string of the VM size of the compute target that will be
created for the training job. The list of available VM sizes
are listed here.
Provide this parameter if you want to create AmlCompute as the compute target
at run time, instead of providing an existing cluster to the
A string of either
A string representing the relative path to the file used to start training.
A named list of the command-line arguments to pass to
the training script specified in
A character vector of CRAN packages to be installed.
A character vector of GitHub packages to be installed.
A character vector of packages to be installed from local directory or custom URL.
A string of the name of the Docker image from
which the image to use for training will be built. If not set, a predefined
image will be used as the base image. To use an image from a
private Docker repository, you will also have to specify the
Indicates whether the environment to run the experiment should
support GPUs. If
A named list of environment variables names and values. These environment variables are set on the process where the user script is being executed.
A string for the size of the Docker container's shared
memory block. For more information, see
Docker run reference.
If not set, a default value of
An integer of the maximum allowed time for the run. Azure ML will attempt to automatically cancel the run if it takes longer than this value.