Upload the specified folder to the given prefix name to the run record.

Note: Runs automatically capture files in the specified output directory, which defaults to "./outputs". Use upload_folder_to_run() only when additional files need to be uploaded or an output directory is not specified.

upload_folder_to_run(name, path, run = NULL)

Arguments

name

A string of the name of the folder of files to upload.

path

A string of the relative local path to the folder to upload.

run

The Run object.

Value

None

Examples

ws <- load_workspace_from_config()
exp <- experiment(ws, name = 'myexperiment')

# Start an interactive logging run
run <- start_logging_run(exp)

# Upload folder to the run record
upload_folder_to_run(name = "important_files",
                     path = "path/on/disk")

# Download a file from the run record
download_file_from_run("important_files/existing_file.txt", "local_file.txt")

See also

upload_files_to_run() download_file_from_run() download_files_from_run()