Float
, Integer
, Boolean
, String
, Datetime
and File
fields. GitRef
, RunState
fields are possible to access, but manual creation or modification of the fields of these types is not possible.FloatSeries
, StringSeries
and FileSeries
.FileSet
can be used for a folder with source files, a folder with image examples, etc. Things that can be easily browsed through the web interface, and are typically accessed as a whole.StringSet
that is used to interact with the tags of the experiment. It's possible to access it and modify it, but manual creation of the fields of this type is not possible.Handler
object. Think of it as a wildcard that can become any of the types once you invoke on it specific logging method. If you invoke .upload()
it becomes a File type, if you invoke .log(2)
it will become a FloatSeries etc. Note that it can also become a Namespace handler if you create a field at a lower level of organization.params
when you have a field params/max_epochs
. Namespace handler can be used as a shortcut for accessing fields by only specifying a relative path within the namespace.float
) - Value to be stored in a field.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.float
value stored in the field.int
) - Value to be stored in a field.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.int
value stored in the field.Boolean
) - Value to be stored in a field.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.bool
value stored in the field.str
or String
) - Value to be stored in a field.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.str
value storedstr
or File
) - Path to the file to be uploaded or File value objectBoolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.File
) - File value objectBoolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.str
, optional, default is None
) - Path to where the file should be downloaded. If None
file will be downloaded to the working directory.destination
is a directory, the file will be downloaded to the specified directory with a filename composed from field name and extension (if present).destination
is a path to a file, the file will be downloaded under the specified name.Str
with the extensions of the stored File.File
value object with converted imageFile
value object with converted objectFile
value object with pickled objectstr
orbytes
) - Text or binary content to stored in the File value object.str
, optional, default is None
) - Extension of the file created that will be used for interpreting the type of content for visualization. If None
it will be bin
for binary content and txt
for text content.File
value object created from the contentIOBase
) - Stream to be converted.str
, optional, default is None
) - Extension of the file created that will be used for interpreting the type of content for visualization. If None
it will be bin
for binary stream and txt
for text stream.File
value object created from the stream.Datetime
fields are possible to access, but manual creation or modification of the fields of these types is not possible.datetime
value storedRunState
fields are possible to access, but manual creation or modification of the fields of these types is not possible. RunState
does not expose any methods.GitRef
fields are possible to access, but manual creation or modification of the fields of these types is not possible. GitRef
does not expose any methods.float
or int
, or collection
of float
or int
) - The value to be logged or collections of values to be logged. If a collection is provided step
and timestamp
parameters must be None
.float
or int
, optional, default is None
) - Index of the log entry being appended. Must be strictly increasing. float
or int
, optional, default is None
) - Time index of the log entry being appended in form of Unix time. If None
current time (time.time()
) will be used as a timestamp.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server. This makes the call synchronous, see Connection modes guide.float
value logged.Boolean
, optional, default is True
) - Whether to include the fetched data should include the timestamp
field.Pandas.DataFrame
containing all the values and their indexes stored in the series field.str
or collection
of str
) - The value to be logged or collections of values to be logged. If a collection is provided step
and timestamp
parameters must be None
.float
or int
, optional, default is None
) - Index of the log entry being appended. Must be strictly increasing. float
or int
, optional, default is None
) - Time index of the log entry being appended in form of Unix time. If None
current time (time.time()
) will be used as a timestamp.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server. This makes the call synchronous, see Connection modes guide.str
value logged.Boolean
, optional, default is True
) - Whether to include the fetched data should include the timestamp
field.Pandas.DataFrame
containing all the values and their indexes stored in the series field.FileSeries
fields accept only image-like files.File
value object or collection
of File
) - The file to be logged or collections of files to be logged. If a collection is provided step
and timestamp
parameters must be None
.float
or int
, optional, default is None
) - Index of the log entry being appended. Must be strictly increasing. float
or int
, optional, default is None
) - Time index of the log entry being appended in form of Unix time. If None
current time (time.time()
) will be used as a timestamp.str
, optional, default is None
) - name of the logged file.str
, optional, default is None
) - short description of the logged file.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server. This makes the call synchronous, see Connection modes guide.str
, optional, default is None
) - The directory where the file will be downloaded. If None
is passed, the file will be downloaded to the current working directory.destination
is a directory, the file will be downloaded to the specified directory with a filename composed from field name and extension (if present).destination
is a path to a file, the file will be downloaded under the specified name.str
, optional, default is None
) - The directory where the file will be downloaded. If None
is passed, the file will be downloaded to the current working directory.destination
is a directory, the file will be downloaded to the specified directory with a filename composed from field name and extension (if present).destination
is a path to a file, the file will be downloaded under the specified name.str
or collection of str
) - Tag or tags to be added.
Tip: If you want you can use emojis in your tags eg. Exploration 🧪
Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server first. This makes the call synchronous, see Connection modes guide.str
or collection of str
) - Tag or tags to be removed. Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server first. This makes the call synchronous, see Connection modes guide.StringSet
.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server first. This makes the call synchronous, see Connection modes guide.set
of str
.FileSet
can be used for a folder with source files, a folder with image examples, etc. Things that can be easily browsed through the web interface, and are typically accessed as a whole.str
or collection of str
) - Path or paths to the files to be uploaded. Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.str
or collection of str
) - Path or paths to files or folders to be deleted. Note that these are paths relative to the FileSet itself e.g. if the FileSet contains file example.txt,
varia/notes.txt
, varia/data.csv
to delete whole subfolder you would pass varia
as the argument.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.str
, optional, default is None
) - The directory where the files in form of a ZIP archive will be downloaded. If None
is passed, the file will be downloaded to the current working directory.destination
is a directory, the file will be downloaded to the specified directory with a filename composed from the field name and the extension.destination
is a path to a file, the file will be downloaded under the specified name.
Artifact
can be used for a dataset in a CSV format, a folder with training images as PNG files, etc. You should use Artifacts for things that are large and you don't want to upload them but you would still like to version and compare them between Runs. str
or Artifact
) - Value to be stored in a field.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.str
, optional, default is None
) - The directory where the files will be downloaded. If None
is passed, the files will be downloaded to the current working directory.destination
is a directory, the file will be downloaded to the specified directory with a filename composed from field name and extension (if present).destination
is a path to a file, the file will be downloaded under the specified name.Artifact
objectArtifactFileData
objects for all the files referenced in the artifacts. ArtifactFileData
has the following fields that you can use:str
, Hash of the filestr
, URL of the file in the Neptune UIint
, Size of the file in KBdict
, dictionary with the following keys:str
.str
) - File path or S3-compatible path to the file or folder that you want to track.str,
optional default is None
) - location inside Neptune artifact namespace where you want to log the metadata.Boolean
, optional, default is False
) - If True
the client will wait to send all tracked metadata to the server before making the assignment. This makes the call synchronous, see Connection modes guide.params/max_epochs
and params/lr
they will be grouped under a params
namespace.Run
object, however, all field paths are relative to the namespace:[]
field lookup. Remember that the resulting paths will be a combination of the namespace path and the provided relative path..assign()
. Remember that the resulting paths will be a combination of the namespace path and the provided relative path.dict
containing all non-File Atom fields values.Handler
object. Think of it as a wildcard that can become any of the types once you invoke on it specific logging method. If you invoke .upload()
it becomes a File type, if you invoke .log(2)
it will become a FloatSeries etc. Note that it can also become a Namespace handler if you create a field at a lower level of organization..assign()
, .log()
, .upload()
, .upload_files()
, etc. of all other field types as well as Namespace handler methods.