set_project: set_project

Description Usage Arguments Details Value

View source: R/client_api_scaffold.R

Description

Attaches a Project to this Client.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
set_project(
  name = NULL,
  desc = NULL,
  tags = NULL,
  attrs = NULL,
  workspace = NULL,
  public_within_org = NULL,
  visibility = NULL,
  id = NULL
)

Arguments

name

Name of the Project. If no name is provided, one will be generated.

desc

Description of the Project.

tags

Tags of the Project.

attrs

Attributes of the Project.

workspace

Workspace under which the Project with name name exists. If not provided, the current user's personal workspace will be used.

public_within_org

If creating a Project in an organization's workspace: True for public, False for private. In older backends, default is private; in newer backends, uses the org's settings by default.

visibility

Visibility to set when creating this project. If not provided, an appropriate default will be used. This parameter should be preferred over public_within_org.

id

ID of the Project. This parameter cannot be provided alongside name, and other parameters will be ignored.

Details

If an accessible Project with name 'name' does not already exist, it will be created and initialized with specified metadata parameters. If such a Project does already exist, it will be retrieved; specifying metadata parameters in this case will raise a warning. If an Experiment is already attached to this Client, it will be detached.

Value

:class:'verta._tracking.project.Project'


botchkoAI/vertaReticulateClient documentation built on Dec. 19, 2021, 10:50 a.m.