Skip to content

Neptune objects#

Neptune objects refer to entities that can contain metadata: a run or project.

Object type   Represents Description Section in app Demo
Run A tracked experiment Object containing model-building metadata. Typically, you create a run every time you execute a script that does model training, retraining, or inference. Runs View example
Project A Neptune project (an ML task you're solving) An object that can be used to log and query project-level metadata. Project metadata View example

Structure of a Neptune object#

Sample structure and field types
run
|-- field - String
|-- namespace
    |-- field - Float
    |-- field - FileSeries
|-- namespace
    |-- namespace
        |-- field - String
        |-- field - FloatSeries
|-- sys
    |-- creation_time - Datetime
    |-- ...

The metadata is organized into namespaces and fields.

  • Namespace: A "folder" inside a Neptune object.

    The sys namespace is always created. It contains basic info about the object. To learn more, see System namespace.

    For runs, the following additional namespaces are created by default: monitoring and source_code. For details, see What Neptune logs automatically.

  • Field: Location inside a namespace where a piece of metadata is stored. Each field is of a certain type, which depends on the type of metadata and how it was logged.

    If you think of the data structure like a tree, fields are the "leaves". A field can be flat (stored at the root of the object) or nested (stored under one or more namespaces).

Learn more