neptune
is a global object that you can use to start new tracked runs or re-connect to already existing ones. It also provides some convenience functionalities like obtaining the last created run.Model
object with an existing or new model.str
, optional, default is None
) - An identifier of an existing model, for example "SUN-PRED"
. If not None
, the model object will be initialized with the existing model instead of creating a new one. The identifier is stored in the object's sys/id
field.str
, optional, default is "Untitled"
) - A name for the new model.str
, optional, default is None
) - A key for the new model. Must be uppercase and unique within the workspace; that is, two models in the same workspace cannot have the same key. Required when creating a new model.str
, optional, default is None
) – Name of a project in a form of MY_WORKSPACE/MY_PROJECT
. If None
, the value of NEPTUNE_PROJECT
environment variable will be taken.str
, optional, default is None
) – User’s API token. If None
, the value of NEPTUNE_API_TOKEN
environment variable will be taken.NEPTUNE_API_TOKEN
environment variable rather than placing your API token in plain text in your source code.str
, optional) – Connection mode in which the tracking will work. Possible values "async"
, "sync"
, "read-only"
, and "debug"
. See the Connection modes guide.
If None
, the value of the NEPTUNE_MODE
environment variable will be taken. If that is not set, the default is async
.float
, optional, default is 5
) - In an asynchronous (default) connection mode, how often an asynchronous thread should synchronize data with Neptune servers. Value in seconds.Model version
object with an existing or new model version.str
, optional, default is None
) - An identifier of an existing model version e.g. "SUN-PRED-11"
. If not None
, the model version object will be initialized with the existing model version instead of creating a new one.str
, optional, default is "Untitled"
) - A name of the new model.str
, optional, default is None
) - An identifier of the model for which the new version should be created. Required when creating a new model version. The identifier is stored in the object's sys/id
field.str
, optional, default is None
) – Name of the project in the form of WORKSPACE_NAME/PROJECT_NAME
. If None
, the value of NEPTUNE_PROJECT
environment variable will be taken.str
, optional, default is None
) – User’s API token. If None
, the value of NEPTUNE_API_TOKEN
environment variable will be taken.NEPTUNE_API_TOKEN
environment variable rather than placing your API token in plain text in your source code.str
, optional) – Connection mode in which the tracking will work. Possible values "async"
, "sync"
, "read-only"
, and "debug"
. See the Connection modes guide.
If None
, the value of the NEPTUNE_MODE
environment variable will be taken. If that is not set, the default is async
.float
, optional, default is 5
) - In an asynchronous (default) connection mode how often asynchronous thread should synchronize data with Neptune servers. Value in seconds.run = neptune.init()
.str
, optional, default is None
) – Name of a project in a form of MY_WORKSPACE/MY_PROJECT
. If None
, the value of NEPTUNE_PROJECT
environment variable will be taken.str
, optional, default is None
) – User’s API token. If None
, the value of NEPTUNE_API_TOKEN
environment variable will be taken.NEPTUNE_API_TOKEN
environment variable rather than placing your API token in plain text in your source code.str
, optional, default is None
) – An existing run's identifier like"SAN-1"
in case of resuming a tracked run. A run with such identifier must exist. The identifier is stored in the object's sys/id
field.
If None
is passed, starts a new tracked run. See Resume run guide.str
, optional, default is None
) – A unique identifier that can be used to log metadata to a single run from multiple files or processes. The maximum length of the identifier is 32 characters. Make sure you are using the same identifier everywhere. See Pipelines guide.None
and the NEPTUNE_CUSTOM_RUN_ID
environment variable is set Neptune will use its value as custom_run_id.str
, optional) – Connection mode in which the tracking will work. Possible values "async"
, "sync"
, "offline"
, "read-only"
, and "debug"
. See the Connection modes guide.
If None
, the value of the NEPTUNE_MODE
environment variable will be taken. If that is not set, the default is async
.str
, optional, default is "Untitled"
) – Editable name of the run. Name is displayed in the run's Details and in Runs table as a column.str
, optional, default is ""
) – Editable description of the run. Description is displayed in the run's Details and can be displayed in the runs view as a column.list
, optional, default is []
) – Must be a list of str
. Tags of the run. They are editable after run is created. Tags are displayed in the run's Details and can be viewed in Runs table view as a column.list
or str
, optional, default is None
) – List of source files to be uploaded. Must be list of str
or single str
. Uploaded sources are displayed in the run’s Source code tab.None
is passed, the Python file from which the run was created will be uploaded. In case of resuming the run no file will be uploaded by default.[]
) to upload no files.".py"
to upload all python source files from the current directory. For Python 3.5 or later, paths of uploaded files on server are resolved as relative to the calculated common root of all uploaded source files. For older Python versions, paths on server are resolved always as relative to the current directory. For recursion lookup use '**/.py'
(for Python 3.5 and later). For more information see glob library.Boolean
, optional, default is True
) – Whether to send run's stdout. Tracked metadata will be stored inside monitoring_namespace
.Boolean
, optional, default is True
) – Whether to send run’s stderr. Tracked metadata will be stored inside monitoring_namespace
.Boolean
, optional, default is True
) – Whether to send hardware monitoring logs (CPU, GPU, Memory utilization). Tracked metadata will be stored inside monitoring_namespace
.Boolean
, optional, default is True
) – Whether to send run’s traceback in case of an exception.str
, optional, default is 'monitoring'
) - Namespace inside which all monitoring logs be stored.Boolean
, optional, default is True
) – Whether to set run's Failed state as True
, if an uncaught exception happens.float
, optional, default is 5
) - In an asynchronous (default) connection mode how often asynchronous thread should synchronize data with Neptune servers. Value in seconds.Run
object.str
, optional, default is None
) – Name of a project in a form of "MY_WORKSPACE/MY_PROJECT"
. If None
, the value of NEPTUNE_PROJECT
environment variable will be taken.str
, optional, default is None
) – User’s API token. If None
, the value of NEPTUNE_API_TOKEN
environment variable will be taken.NEPTUNE_API_TOKEN
environment variable rather than placing your API token in plain text in your source code.str
, optional) – Connection mode in which the tracking will work. Possible values "async"
, "sync"
, "debug"
, and "read-only"
. See Connection modes guide.
If None
, the value of the NEPTUNE_MODE
environment variable will be taken. If that is not set, the default is async
.float
, optional, default is 5
) - In an asynchronous (default) connection mode how often asynchronous thread should synchronize data with Neptune servers. Value in seconds.Project
object that can be used to interact with the project as a whole like fetching its metadata or fetching data from Runs table.neptune.init_project(mode="read-only")
.str
, optional, default is None
) – Name of a project in a form of "MY_WORKSPACE/MY_PROJECT"
. If None
, the value of NEPTUNE_PROJECT
environment variable will be taken.str
, optional, default is None
) – User’s API token. If None
, the value of NEPTUNE_API_TOKEN
environment variable will be taken.NEPTUNE_API_TOKEN
environment variable rather than placing your API token in plain text in your source code.Project
object that can be used to interact with the project as a whole, like fetching its metadata or fetching data from the runs table.api_token
parameter of the .init()
method, either by passing it as an argument or by saving it as an environment variable.