From e69eea0250da6474c982627520d3f2ba11291259 Mon Sep 17 00:00:00 2001 From: heemanshusuri <51678909+heemanshusuri@users.noreply.github.com> Date: Mon, 11 Nov 2019 14:00:17 -0800 Subject: [PATCH] Adding None return for functions which do not return anything (#192) * Adding unit tests * Fixing CRAN issues * Adding tensorflow authors in description * Version bump * Saving files anda data to tempdir * Fixing build issues * Adding None return for functions which do not return anything --- R/compute.R | 4 ++++ R/datastore.R | 1 + R/environment.R | 1 + R/install.R | 1 + R/keyvault.R | 2 ++ R/model.R | 5 +++++ R/run.R | 16 ++++++++++++++++ R/webservice-aci.R | 1 + R/webservice-aks.R | 1 + R/webservice-local.R | 3 +++ R/webservice.R | 3 +++ R/workspace.R | 3 +++ man/complete_run.Rd | 3 +++ man/delete_compute.Rd | 3 +++ man/delete_local_webservice.Rd | 3 +++ man/delete_model.Rd | 3 +++ man/delete_secrets.Rd | 3 +++ man/delete_webservice.Rd | 3 +++ man/delete_workspace.Rd | 3 +++ man/detach_aks_compute.Rd | 3 +++ man/download_file_from_run.Rd | 3 +++ man/download_files_from_run.Rd | 3 +++ man/generate_docker_file.Rd | 3 +++ man/generate_new_webservice_key.Rd | 3 +++ man/install_azureml.Rd | 3 +++ man/log_accuracy_table_to_run.Rd | 3 +++ man/log_confusion_matrix_to_run.Rd | 3 +++ man/log_image_to_run.Rd | 3 +++ man/log_list_to_run.Rd | 3 +++ man/log_metric_to_run.Rd | 3 +++ man/log_predictions_to_run.Rd | 3 +++ man/log_residuals_to_run.Rd | 3 +++ man/log_row_to_run.Rd | 3 +++ man/log_table_to_run.Rd | 3 +++ man/pull_model_package_image.Rd | 3 +++ man/reload_local_webservice_assets.Rd | 3 +++ man/save_model_package_files.Rd | 3 +++ man/set_default_datastore.Rd | 3 +++ man/set_secrets.Rd | 3 +++ man/unregister_datastore.Rd | 3 +++ man/update_aci_webservice.Rd | 3 +++ man/update_aks_webservice.Rd | 3 +++ man/update_aml_compute.Rd | 3 +++ man/update_local_webservice.Rd | 3 +++ man/upload_files_to_run.Rd | 3 +++ man/upload_folder_to_run.Rd | 3 +++ man/view_run_details.Rd | 3 +++ man/wait_for_deployment.Rd | 3 +++ man/wait_for_model_package_creation.Rd | 3 +++ man/wait_for_provisioning_completion.Rd | 3 +++ man/wait_for_run_completion.Rd | 3 +++ man/write_workspace_config.Rd | 3 +++ 52 files changed, 161 insertions(+) diff --git a/R/compute.R b/R/compute.R index 452dd4a7..de0cab49 100644 --- a/R/compute.R +++ b/R/compute.R @@ -134,6 +134,7 @@ get_compute <- function(workspace, cluster_name) { #' `create_aml_compute()` or `create_aks_compute()` call. #' @param cluster The `AmlCompute` or `AksCompute` object. #' @param show_output If `TRUE`, more verbose output will be provided. +#' @return None #' @export #' @seealso #' `create_aml_compute()`, `create_aks_compute()` @@ -148,6 +149,7 @@ wait_for_provisioning_completion <- function(cluster, show_output = FALSE) { #' Remove the compute object from its associated workspace and delete the #' corresponding cloud-based resource. #' @param cluster The `AmlCompute` or `AksCompute` object. +#' @return None #' @export #' @examples #' \dontrun{ @@ -172,6 +174,7 @@ delete_compute <- function(cluster) { #' the cluster. #' @param idle_seconds_before_scaledown An integer of the node idle time #' in seconds before scaling down the cluster. +#' @return None #' @export #' @md update_aml_compute <- function(cluster, min_nodes = NULL, max_nodes = NULL, @@ -342,6 +345,7 @@ attach_aks_compute <- function(workspace, #' underlying cloud resource will be deleted; the association will #' just be removed. #' @param cluster The `AksCompute` object. +#' @return None #' @export #' @md detach_aks_compute <- function(cluster) { diff --git a/R/datastore.R b/R/datastore.R index a49d5d09..8cb090c8 100644 --- a/R/datastore.R +++ b/R/datastore.R @@ -256,6 +256,7 @@ register_azure_file_share_datastore <- function(workspace, #' Unregister the datastore from its associated workspace. The #' underlying Azure storage will not be deleted. #' @param datastore The `AzureBlobDatastore` or `AzureFileDatastore` object. +#' @return None #' @export #' @md unregister_datastore <- function(datastore) { diff --git a/R/environment.R b/R/environment.R index 6587c5e3..7215365d 100644 --- a/R/environment.R +++ b/R/environment.R @@ -230,6 +230,7 @@ container_registry <- function(address = NULL, #' local, directory or custom url. #' @param install_system_packages logical parameter to specify if system #' packages should be installed at runtime. +#' @return Dockerfile string generate_docker_file <- function(custom_docker_image = NULL, cran_packages = NULL, github_packages = NULL, diff --git a/R/install.R b/R/install.R index 542537b4..9b2069c6 100644 --- a/R/install.R +++ b/R/install.R @@ -7,6 +7,7 @@ #' @param conda_python_version version of python for conda environment #' @param restart_session restart R session after installation #' @param remove_existing_env delete the conda environment if already exists +#' @return None #' @export install_azureml <- function(version = "1.0.69", envname = "r-azureml", diff --git a/R/keyvault.R b/R/keyvault.R index 6760c58c..70ce1c7d 100644 --- a/R/keyvault.R +++ b/R/keyvault.R @@ -9,6 +9,7 @@ #' @param keyvault The `Keyvault` object. #' @param secrets The named list of secrets to be added to the keyvault, #' where element name corresponds to the secret name. +#' @return None #' @export #' @examples #' \dontrun{ @@ -49,6 +50,7 @@ get_secrets <- function(keyvault, secrets) { #' a specified set of secret names. #' @param keyvault The `Keyvault` object. #' @param secrets A vector of secret names. +#' @return None #' @export #' @md delete_secrets <- function(keyvault, secrets) { diff --git a/R/model.R b/R/model.R index b6c35bb0..4da7eef2 100644 --- a/R/model.R +++ b/R/model.R @@ -147,6 +147,7 @@ deserialize_to_model <- function(workspace, model_payload) { #' you cannot delete a registered model that is being used by an active #' web service deployment. #' @param model The `Model` object. +#' @return None #' @export #' @md delete_model <- function(model) { @@ -345,6 +346,7 @@ get_model_package_creation_logs <- function(package, #' After you've pulled the image, you can start a local container based #' on this image using Docker commands. #' @param package The `ModelPackage` object. +#' @return None #' @export #' @seealso #' `package_model()` @@ -372,6 +374,7 @@ pull_model_package_image <- function(package) { #' @param package The `ModelPackage` object. #' @param output_directory A string of the local directory that #' will be created to contain the contents of the package. +#' @return None #' @export #' @seealso #' `package_model()`, `get_model_package_container_registry()` @@ -386,6 +389,7 @@ save_model_package_files <- function(package, output_directory) { #' @param package The `ModelPackage` object. #' @param show_output If `TRUE`, print more verbose output. Defaults to #' `FALSE`. +#' @return None #' @export #' @md wait_for_model_package_creation <- function(package, show_output = FALSE) { @@ -476,6 +480,7 @@ inference_config <- function(entry_script, #' the image. #' @param source_directory paths to folders that contains all files to #' create the image. +#' @return None #' @noRd generate_score_python_wrapper <- function(entry_script, source_directory) { score_py_template <- sprintf("# This is auto-generated python wrapper. diff --git a/R/run.R b/R/run.R index 93a6dc4e..7163f6b1 100644 --- a/R/run.R +++ b/R/run.R @@ -27,6 +27,7 @@ get_run_metrics <- function(run) { #' after submitting an experiment run with `submit_experiment()`. #' @param run The `Run` object. #' @param show_output If `TRUE`, print verbose output to console. +#' @return None #' @export #' @md wait_for_run_completion <- function(run, show_output = TRUE) { @@ -107,6 +108,7 @@ get_run <- function(experiment, run_id) { #' @param name A string of the name of the artifact to be downloaded. #' @param output_file_path A string of the local path where to download #' the artifact to. +#' @return None #' @export #' @md download_file_from_run <- function(run, name, output_file_path = NULL) { @@ -129,6 +131,7 @@ download_file_from_run <- function(run, name, output_file_path = NULL) { #' @param output_paths (Optional) A list of strings of the local filepaths #' where the artifacts will be downloaded to. #' @param batch_size An int of the number of files to download per batch. +#' @return None #' @md #' @export download_files_from_run <- function(run, prefix = NULL, output_directory = NULL, @@ -228,6 +231,7 @@ get_secrets_from_run <- function(run, secrets) { #' @param value The value of the metric. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @examples #' \dontrun{ @@ -254,6 +258,7 @@ log_metric_to_run <- function(name, value, run = NULL) { #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @details #' The calculation of the accuracy table is similar to the calculation of @@ -318,6 +323,7 @@ log_accuracy_table_to_run <- function(name, value, description = "", #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @md log_confusion_matrix_to_run <- function(name, value, description = "", @@ -342,6 +348,7 @@ log_confusion_matrix_to_run <- function(name, value, description = "", #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @md log_image_to_run <- function(name, path = NULL, plot = NULL, @@ -377,6 +384,7 @@ log_image_to_run <- function(name, path = NULL, plot = NULL, #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @examples #' \dontrun{ @@ -405,6 +413,7 @@ log_list_to_run <- function(name, value, description = "", run = NULL) { #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @examples #' \dontrun{ @@ -438,6 +447,7 @@ log_predictions_to_run <- function(name, value, description = "", run = NULL) { #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @examples #' \dontrun{ @@ -471,6 +481,7 @@ log_residuals_to_run <- function(name, value, description = "", run = NULL) { #' to the current run from the service context. #' @param ... Each named parameter generates a column with the value #' specified. +#' @return None #' @export #' @examples #' # Log an arbitrary tuple @@ -507,6 +518,7 @@ log_row_to_run <- function(name, description = "", run = NULL, ...) { #' @param description (Optional) A string of the metric description. #' @param run The `Run` object. If not specified, will default #' to the current run from the service context. +#' @return None #' @export #' @examples #' \dontrun{ @@ -535,6 +547,7 @@ log_table_to_run <- function(name, value, description = "", run = NULL) { #' run details table will show up in the code chunk output #' instead of the Viewer. #' @param run The `Run` object. +#' @return None #' @export #' @md view_run_details <- function(run) { @@ -639,6 +652,7 @@ view_run_details <- function(run) { #' @param timeout_seconds An int of the timeout in seconds for uploading #' the files. #' @param run The `Run` object. +#' @return None #' @export #' @examples #' \dontrun{ @@ -684,6 +698,7 @@ upload_files_to_run <- function(names, paths, timeout_seconds = NULL, #' @param name A string of the name of the folder of files to upload. #' @param path A string of the relative local path to the folder to upload. #' @param run The `Run` object. +#' @return None #' @export #' @examples #' \dontrun{ @@ -715,6 +730,7 @@ upload_folder_to_run <- function(name, path, run = NULL) { #' @description #' Mark the run as completed. Use for an interactive logging run. #' @param run The `Run` object. +#' @return None #' @export #' @seealso #' `start_logging_run()` diff --git a/R/webservice-aci.R b/R/webservice-aci.R index 34a33ce1..ff427b6f 100644 --- a/R/webservice-aci.R +++ b/R/webservice-aci.R @@ -98,6 +98,7 @@ aci_webservice_deployment_config <- function(cpu_cores = NULL, #' @param enable_app_insights If `TRUE` enable AppInsights for the web service. #' @param models A list of `Model` objects to package into the updated service. #' @param inference_config An `InferenceConfig` object. +#' @return None #' @export #' @md update_aci_webservice <- function(webservice, diff --git a/R/webservice-aks.R b/R/webservice-aks.R index 99d71fba..bed25e76 100644 --- a/R/webservice-aks.R +++ b/R/webservice-aks.R @@ -220,6 +220,7 @@ aks_webservice_deployment_config <- function( #' the web service. If enabled, users can access the web service by fetching #' an access token using their Azure Active Directory credentials. #' Both `token_auth_enabled` and `auth_enabled` cannot be set to `TRUE`. +#' @return None #' @export #' @md update_aks_webservice <- function(webservice, autoscale_enabled = NULL, diff --git a/R/webservice-local.R b/R/webservice-local.R index 1d29c17d..f0495b19 100644 --- a/R/webservice-local.R +++ b/R/webservice-local.R @@ -36,6 +36,7 @@ local_webservice_deployment_config <- function(port = NULL) { #' @param wait If `TRUE`, wait for the service's container to reach a #' healthy state. Defaults to `FALSE`. #' @param inference_config An `InferenceConfig` object. +#' @return None #' @export #' @md update_local_webservice <- function(webservice, models = NULL, @@ -57,6 +58,7 @@ update_local_webservice <- function(webservice, models = NULL, #' @param delete_cache If `TRUE`, delete the temporary files cached for #' the service. #' @param delete_image If `TRUE`, delete the service's Docker image. +#' @return None #' @export #' @md delete_local_webservice <- function(webservice, @@ -77,6 +79,7 @@ delete_local_webservice <- function(webservice, #' @param webservice The `LocalWebservice` object. #' @param wait If `TRUE`, wait for the service's container to reach a #' healthy state. Defaults to `FALSE`. +#' @return None #' @export #' @md reload_local_webservice_assets <- function(webservice, wait = FALSE) { diff --git a/R/webservice.R b/R/webservice.R index 5484c70b..ff1f77d5 100644 --- a/R/webservice.R +++ b/R/webservice.R @@ -26,6 +26,7 @@ get_webservice <- function(workspace, name) { #' `AksWebservice` object. #' @param show_output If `TRUE`, print more verbose output. Defaults #' to `FALSE`. +#' @return None #' @export #' @seealso #' `deploy_model()` @@ -89,6 +90,7 @@ get_webservice_keys <- function(webservice) { #' #' To delete a `LocalWebservice` see `delete_local_webservice()`. #' @param webservice The `AciWebservice` or `AksWebservice` object. +#' @return None #' @export #' @md delete_webservice <- function(webservice) { @@ -137,6 +139,7 @@ invoke_webservice <- function(webservice, input_data) { #' @param webservice The `AciWebservice` or `AksWebservice` object. #' @param key_type A string of which key to regenerate. Options are #' "Primary" or "Secondary". +#' @return None #' @export #' @md generate_new_webservice_key <- function(webservice, key_type) { diff --git a/R/workspace.R b/R/workspace.R index bb71a700..1897afeb 100644 --- a/R/workspace.R +++ b/R/workspace.R @@ -177,6 +177,7 @@ load_workspace_from_config <- function(path = NULL, file_name = NULL) { #' resources, i.e. ACR, storage account, key value, and application insights #' will also be deleted. #' @param no_wait If `FALSE` do not wait for the workspace deletion to complete. +#' @return None #' @export #' @md delete_workspace <- function(workspace, @@ -220,6 +221,7 @@ list_workspaces <- function(subscription_id, resource_group = NULL) { #' The parameter defaults to the current working directory. #' @param file_name A string of the name to use for the config file. The #' parameter defaults to `'config.json'`. +#' @return None #' @export #' @md write_workspace_config <- function(workspace, path = NULL, file_name = NULL) { @@ -314,6 +316,7 @@ get_workspace_details <- function(workspace) { #' Set the default datastore associated with the workspace. #' @param workspace The `Workspace` object. #' @param datastore_name The name of the datastore to be set as default. +#' @return None #' @export #' @md set_default_datastore <- function(workspace, datastore_name) { diff --git a/man/complete_run.Rd b/man/complete_run.Rd index 4483b831..c7aa24c6 100644 --- a/man/complete_run.Rd +++ b/man/complete_run.Rd @@ -9,6 +9,9 @@ complete_run(run) \arguments{ \item{run}{The \code{Run} object.} } +\value{ +None +} \description{ Mark the run as completed. Use for an interactive logging run. } diff --git a/man/delete_compute.Rd b/man/delete_compute.Rd index 2b7f4be6..8b67bfa6 100644 --- a/man/delete_compute.Rd +++ b/man/delete_compute.Rd @@ -9,6 +9,9 @@ delete_compute(cluster) \arguments{ \item{cluster}{The \code{AmlCompute} or \code{AksCompute} object.} } +\value{ +None +} \description{ Remove the compute object from its associated workspace and delete the corresponding cloud-based resource. diff --git a/man/delete_local_webservice.Rd b/man/delete_local_webservice.Rd index 1c90d88e..8ebb7f8b 100644 --- a/man/delete_local_webservice.Rd +++ b/man/delete_local_webservice.Rd @@ -15,6 +15,9 @@ the service.} \item{delete_image}{If \code{TRUE}, delete the service's Docker image.} } +\value{ +None +} \description{ Delete a local web service from the local machine. This function call is not asynchronous; it runs until the service is deleted. diff --git a/man/delete_model.Rd b/man/delete_model.Rd index f2c960d1..91036495 100644 --- a/man/delete_model.Rd +++ b/man/delete_model.Rd @@ -9,6 +9,9 @@ delete_model(model) \arguments{ \item{model}{The \code{Model} object.} } +\value{ +None +} \description{ Delete the registered model from its associated workspace. Note that you cannot delete a registered model that is being used by an active diff --git a/man/delete_secrets.Rd b/man/delete_secrets.Rd index 4f08e2b1..80bfbd98 100644 --- a/man/delete_secrets.Rd +++ b/man/delete_secrets.Rd @@ -11,6 +11,9 @@ delete_secrets(keyvault, secrets) \item{secrets}{A vector of secret names.} } +\value{ +None +} \description{ Delete secrets from the keyvault associated with the workspace for a specified set of secret names. diff --git a/man/delete_webservice.Rd b/man/delete_webservice.Rd index a738ea2a..5abb8cc8 100644 --- a/man/delete_webservice.Rd +++ b/man/delete_webservice.Rd @@ -9,6 +9,9 @@ delete_webservice(webservice) \arguments{ \item{webservice}{The \code{AciWebservice} or \code{AksWebservice} object.} } +\value{ +None +} \description{ Delete a deployed ACI or AKS web service from the given workspace. This function call is not asynchronous; it runs until the resource is diff --git a/man/delete_workspace.Rd b/man/delete_workspace.Rd index ada96e52..8760b4ce 100644 --- a/man/delete_workspace.Rd +++ b/man/delete_workspace.Rd @@ -16,6 +16,9 @@ will also be deleted.} \item{no_wait}{If \code{FALSE} do not wait for the workspace deletion to complete.} } +\value{ +None +} \description{ Delete the Azure Machine Learning workspace resource. \code{delete_workspace()} can also delete the workspace's associated resources. diff --git a/man/detach_aks_compute.Rd b/man/detach_aks_compute.Rd index 25f8f3dd..ecae1234 100644 --- a/man/detach_aks_compute.Rd +++ b/man/detach_aks_compute.Rd @@ -9,6 +9,9 @@ detach_aks_compute(cluster) \arguments{ \item{cluster}{The \code{AksCompute} object.} } +\value{ +None +} \description{ Detach the AksCompute cluster from its associated workspace. No underlying cloud resource will be deleted; the association will diff --git a/man/download_file_from_run.Rd b/man/download_file_from_run.Rd index 21d852a7..d9f5e443 100644 --- a/man/download_file_from_run.Rd +++ b/man/download_file_from_run.Rd @@ -14,6 +14,9 @@ download_file_from_run(run, name, output_file_path = NULL) \item{output_file_path}{A string of the local path where to download the artifact to.} } +\value{ +None +} \description{ Download a file from the run record. You can download any file that was uploaded to the run record via \code{upload_files_to_run()} or diff --git a/man/download_files_from_run.Rd b/man/download_files_from_run.Rd index 3112fefc..3fa88bcd 100644 --- a/man/download_files_from_run.Rd +++ b/man/download_files_from_run.Rd @@ -22,6 +22,9 @@ where the artifacts will be downloaded to.} \item{batch_size}{An int of the number of files to download per batch.} } +\value{ +None +} \description{ Download files from the run record. You can download any files that were uploaded to the run record via \code{upload_files_to_run()} or diff --git a/man/generate_docker_file.Rd b/man/generate_docker_file.Rd index 6a5f3618..68c08e18 100644 --- a/man/generate_docker_file.Rd +++ b/man/generate_docker_file.Rd @@ -23,6 +23,9 @@ local, directory or custom url.} \item{install_system_packages}{logical parameter to specify if system packages should be installed at runtime.} } +\value{ +Dockerfile string +} \description{ Generate a dockerfile string to build the image for training. } diff --git a/man/generate_new_webservice_key.Rd b/man/generate_new_webservice_key.Rd index 65f724ac..677f775b 100644 --- a/man/generate_new_webservice_key.Rd +++ b/man/generate_new_webservice_key.Rd @@ -12,6 +12,9 @@ generate_new_webservice_key(webservice, key_type) \item{key_type}{A string of which key to regenerate. Options are "Primary" or "Secondary".} } +\value{ +None +} \description{ Regenerate either the primary or secondary authentication key for an \code{AciWebservice} or \code{AksWebservice}.The web service must have diff --git a/man/install_azureml.Rd b/man/install_azureml.Rd index 73504a29..58d9461b 100644 --- a/man/install_azureml.Rd +++ b/man/install_azureml.Rd @@ -19,6 +19,9 @@ install_azureml(version = "1.0.69", envname = "r-azureml", \item{remove_existing_env}{delete the conda environment if already exists} } +\value{ +None +} \description{ Install azureml sdk package } diff --git a/man/log_accuracy_table_to_run.Rd b/man/log_accuracy_table_to_run.Rd index 93a31899..46759f5f 100644 --- a/man/log_accuracy_table_to_run.Rd +++ b/man/log_accuracy_table_to_run.Rd @@ -16,6 +16,9 @@ log_accuracy_table_to_run(name, value, description = "", run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ The accuracy table metric is a multi-use non-scalar metric that can be used to produce multiple types of line charts that vary continuously diff --git a/man/log_confusion_matrix_to_run.Rd b/man/log_confusion_matrix_to_run.Rd index b0e5f2a8..84669903 100644 --- a/man/log_confusion_matrix_to_run.Rd +++ b/man/log_confusion_matrix_to_run.Rd @@ -16,6 +16,9 @@ log_confusion_matrix_to_run(name, value, description = "", run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ Log a confusion matrix metric to a run } diff --git a/man/log_image_to_run.Rd b/man/log_image_to_run.Rd index 4a6ff655..c1393c01 100644 --- a/man/log_image_to_run.Rd +++ b/man/log_image_to_run.Rd @@ -19,6 +19,9 @@ log_image_to_run(name, path = NULL, plot = NULL, description = "", \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ Log an image to the run with the give metric name. Use \code{log_image_to_run()} to log an image file or ggplot2 plot to the diff --git a/man/log_list_to_run.Rd b/man/log_list_to_run.Rd index ddb97507..c5fdd54e 100644 --- a/man/log_list_to_run.Rd +++ b/man/log_list_to_run.Rd @@ -16,6 +16,9 @@ log_list_to_run(name, value, description = "", run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ Log a vector with the given metric name to the run. } diff --git a/man/log_metric_to_run.Rd b/man/log_metric_to_run.Rd index 55bb07d1..5e34c42d 100644 --- a/man/log_metric_to_run.Rd +++ b/man/log_metric_to_run.Rd @@ -14,6 +14,9 @@ log_metric_to_run(name, value, run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ Log a numerical or string value with the given metric name to the run. Logging a metric to a run causes that metric to diff --git a/man/log_predictions_to_run.Rd b/man/log_predictions_to_run.Rd index 77e3377c..c89a0492 100644 --- a/man/log_predictions_to_run.Rd +++ b/man/log_predictions_to_run.Rd @@ -16,6 +16,9 @@ log_predictions_to_run(name, value, description = "", run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ \code{log_predictions_to_run()} logs a metric score that can be used to compare the distributions of true target values to the distribution diff --git a/man/log_residuals_to_run.Rd b/man/log_residuals_to_run.Rd index 6ed1e364..25448f2b 100644 --- a/man/log_residuals_to_run.Rd +++ b/man/log_residuals_to_run.Rd @@ -16,6 +16,9 @@ log_residuals_to_run(name, value, description = "", run = NULL) \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ \code{log_residuals_to_run()} logs the data needed to display a histogram of residuals for a regression task. The residuals are \code{predicted - actual}. diff --git a/man/log_row_to_run.Rd b/man/log_row_to_run.Rd index b303e1f9..e551fe10 100644 --- a/man/log_row_to_run.Rd +++ b/man/log_row_to_run.Rd @@ -17,6 +17,9 @@ to the current run from the service context.} \item{...}{Each named parameter generates a column with the value specified.} } +\value{ +None +} \description{ Using \code{log_row_to_run()} creates a metric with multiple columns as described in \code{...}. Each named parameter generates a column diff --git a/man/log_table_to_run.Rd b/man/log_table_to_run.Rd index aaaa9b70..64804416 100644 --- a/man/log_table_to_run.Rd +++ b/man/log_table_to_run.Rd @@ -17,6 +17,9 @@ element name corresponds to the column name).} \item{run}{The \code{Run} object. If not specified, will default to the current run from the service context.} } +\value{ +None +} \description{ Log a table metric with the given metric name to the run. The table value is a named list where each element corresponds to diff --git a/man/pull_model_package_image.Rd b/man/pull_model_package_image.Rd index 55488c7d..412c7046 100644 --- a/man/pull_model_package_image.Rd +++ b/man/pull_model_package_image.Rd @@ -10,6 +10,9 @@ pull_model_package_image(package) \arguments{ \item{package}{The \code{ModelPackage} object.} } +\value{ +None +} \description{ Pull the Docker image from a created \code{ModelPackage} to your local Docker environment. The output of this call will diff --git a/man/reload_local_webservice_assets.Rd b/man/reload_local_webservice_assets.Rd index 5bdd429f..2056dac8 100644 --- a/man/reload_local_webservice_assets.Rd +++ b/man/reload_local_webservice_assets.Rd @@ -12,6 +12,9 @@ reload_local_webservice_assets(webservice, wait = FALSE) \item{wait}{If \code{TRUE}, wait for the service's container to reach a healthy state. Defaults to \code{FALSE}.} } +\value{ +None +} \description{ This restarts the service's container with copies of updated assets, including the entry script and local dependencies, but it does not diff --git a/man/save_model_package_files.Rd b/man/save_model_package_files.Rd index d7e65f06..46b8d724 100644 --- a/man/save_model_package_files.Rd +++ b/man/save_model_package_files.Rd @@ -13,6 +13,9 @@ save_model_package_files(package, output_directory) \item{output_directory}{A string of the local directory that will be created to contain the contents of the package.} } +\value{ +None +} \description{ Download the Dockerfile, model, and other assets needed to build an image locally from a created \code{ModelPackage}. diff --git a/man/set_default_datastore.Rd b/man/set_default_datastore.Rd index b16c9f76..6e59ca4d 100644 --- a/man/set_default_datastore.Rd +++ b/man/set_default_datastore.Rd @@ -11,6 +11,9 @@ set_default_datastore(workspace, datastore_name) \item{datastore_name}{The name of the datastore to be set as default.} } +\value{ +None +} \description{ Set the default datastore associated with the workspace. } diff --git a/man/set_secrets.Rd b/man/set_secrets.Rd index 9a949ed3..28f1d153 100644 --- a/man/set_secrets.Rd +++ b/man/set_secrets.Rd @@ -12,6 +12,9 @@ set_secrets(keyvault, secrets) \item{secrets}{The named list of secrets to be added to the keyvault, where element name corresponds to the secret name.} } +\value{ +None +} \description{ Add a named list of secrets into the keyvault associated with the workspace. diff --git a/man/unregister_datastore.Rd b/man/unregister_datastore.Rd index 3dc61898..7a6e5222 100644 --- a/man/unregister_datastore.Rd +++ b/man/unregister_datastore.Rd @@ -9,6 +9,9 @@ unregister_datastore(datastore) \arguments{ \item{datastore}{The \code{AzureBlobDatastore} or \code{AzureFileDatastore} object.} } +\value{ +None +} \description{ Unregister the datastore from its associated workspace. The underlying Azure storage will not be deleted. diff --git a/man/update_aci_webservice.Rd b/man/update_aci_webservice.Rd index 8c755659..1220fb80 100644 --- a/man/update_aci_webservice.Rd +++ b/man/update_aci_webservice.Rd @@ -38,6 +38,9 @@ web service.} \item{inference_config}{An \code{InferenceConfig} object.} } +\value{ +None +} \description{ Update an ACI web service with the provided properties. You can update the web service to use a new model, a new entry script, or new dependencies diff --git a/man/update_aks_webservice.Rd b/man/update_aks_webservice.Rd index 3ea1b2c1..e28af3ae 100644 --- a/man/update_aks_webservice.Rd +++ b/man/update_aks_webservice.Rd @@ -101,6 +101,9 @@ the web service. If enabled, users can access the web service by fetching an access token using their Azure Active Directory credentials. Both \code{token_auth_enabled} and \code{auth_enabled} cannot be set to \code{TRUE}.} } +\value{ +None +} \description{ Update an AKS web service with the provided properties. You can update the web service to use a new model, a new entry script, or new dependencies diff --git a/man/update_aml_compute.Rd b/man/update_aml_compute.Rd index 1ad416c9..65a00bb0 100644 --- a/man/update_aml_compute.Rd +++ b/man/update_aml_compute.Rd @@ -19,6 +19,9 @@ the cluster.} \item{idle_seconds_before_scaledown}{An integer of the node idle time in seconds before scaling down the cluster.} } +\value{ +None +} \description{ Update the scale settings for an existing AmlCompute cluster. } diff --git a/man/update_local_webservice.Rd b/man/update_local_webservice.Rd index c7593608..12bdfa54 100644 --- a/man/update_local_webservice.Rd +++ b/man/update_local_webservice.Rd @@ -20,6 +20,9 @@ healthy state. Defaults to \code{FALSE}.} \item{inference_config}{An \code{InferenceConfig} object.} } +\value{ +None +} \description{ Update a local web service with the provided properties. You can update the web service to use a new model, a new entry script, or new dependencies diff --git a/man/upload_files_to_run.Rd b/man/upload_files_to_run.Rd index 8eff228b..3cce158b 100644 --- a/man/upload_files_to_run.Rd +++ b/man/upload_files_to_run.Rd @@ -17,6 +17,9 @@ the files.} \item{run}{The \code{Run} object.} } +\value{ +None +} \description{ Upload files to the run record. diff --git a/man/upload_folder_to_run.Rd b/man/upload_folder_to_run.Rd index 49152118..45767b8b 100644 --- a/man/upload_folder_to_run.Rd +++ b/man/upload_folder_to_run.Rd @@ -13,6 +13,9 @@ upload_folder_to_run(name, path, run = NULL) \item{run}{The \code{Run} object.} } +\value{ +None +} \description{ Upload the specified folder to the given prefix name to the run record. diff --git a/man/view_run_details.Rd b/man/view_run_details.Rd index e996751f..b0f7eaf4 100644 --- a/man/view_run_details.Rd +++ b/man/view_run_details.Rd @@ -9,6 +9,9 @@ view_run_details(run) \arguments{ \item{run}{The \code{Run} object.} } +\value{ +None +} \description{ Plot table of run details in RStudio Viewer or browser. This table does not auto-refresh. To see current values, diff --git a/man/wait_for_deployment.Rd b/man/wait_for_deployment.Rd index 56617dbd..a316837a 100644 --- a/man/wait_for_deployment.Rd +++ b/man/wait_for_deployment.Rd @@ -13,6 +13,9 @@ wait_for_deployment(webservice, show_output = FALSE) \item{show_output}{If \code{TRUE}, print more verbose output. Defaults to \code{FALSE}.} } +\value{ +None +} \description{ Automatically poll on the running web service deployment and wait for the web service to reach a terminal state. Will throw diff --git a/man/wait_for_model_package_creation.Rd b/man/wait_for_model_package_creation.Rd index 557df7c8..a536d48c 100644 --- a/man/wait_for_model_package_creation.Rd +++ b/man/wait_for_model_package_creation.Rd @@ -12,6 +12,9 @@ wait_for_model_package_creation(package, show_output = FALSE) \item{show_output}{If \code{TRUE}, print more verbose output. Defaults to \code{FALSE}.} } +\value{ +None +} \description{ Wait for a model package creation to reach a terminal state. } diff --git a/man/wait_for_provisioning_completion.Rd b/man/wait_for_provisioning_completion.Rd index ecf0b277..ed9be259 100644 --- a/man/wait_for_provisioning_completion.Rd +++ b/man/wait_for_provisioning_completion.Rd @@ -11,6 +11,9 @@ wait_for_provisioning_completion(cluster, show_output = FALSE) \item{show_output}{If \code{TRUE}, more verbose output will be provided.} } +\value{ +None +} \description{ Wait for a cluster to finish provisioning. Typically invoked after a \code{create_aml_compute()} or \code{create_aks_compute()} call. diff --git a/man/wait_for_run_completion.Rd b/man/wait_for_run_completion.Rd index b268d985..09b38e29 100644 --- a/man/wait_for_run_completion.Rd +++ b/man/wait_for_run_completion.Rd @@ -11,6 +11,9 @@ wait_for_run_completion(run, show_output = TRUE) \item{show_output}{If \code{TRUE}, print verbose output to console.} } +\value{ +None +} \description{ Wait for the run to reach a terminal state. Typically called after submitting an experiment run with \code{submit_experiment()}. diff --git a/man/write_workspace_config.Rd b/man/write_workspace_config.Rd index 068d96f1..e223d209 100644 --- a/man/write_workspace_config.Rd +++ b/man/write_workspace_config.Rd @@ -15,6 +15,9 @@ The parameter defaults to the current working directory.} \item{file_name}{A string of the name to use for the config file. The parameter defaults to \code{'config.json'}.} } +\value{ +None +} \description{ Write out the workspace ARM properties to a config file. Workspace ARM properties can be loaded later using \code{load_workspace_from_config()}.