API reference

•  Init functions

  ---

  Initialize new or existing Neptune objects.

  • init_run()
  • init_model()
  • init_model_version()
  • init_project()

•  Management functions

  ---

  Manage your workspace and users.

  • invite_to_workspace()
  • create_project()
  • trash_objects()
  • more →

•  Field types

  ---

  A field is a location where metadata is logged. Depending on their types, fields have different methods and properties.

  • Artifact
  • File
  • FileSeries
  • FloatSeries
  • Handler
  • more →

•  Environment variables

  ---

  Use environment variables to make your setup more smooth and secure.

  • NEPTUNE_API_TOKEN
  • NEPTUNE_PROJECT
  • NEPTUNE_CUSTOM_RUN_ID
  • NEPTUNE_MODE
  • NEPTUNE_DATA_DIRECTORY
  • NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE

•  Connection modes

  ---

  Set the logging and synchronization mode.

  • async (default)
  • debug
  • offline
  • read-only
  • sync

•  CLI

  ---

  You can use the Neptune Command Line Interface to manage and sync locally stored metadata.

  • neptune clear
  • neptune status
  • neptune sync

Neptune client library

Python

The Neptune Python API has the following structure:

• Packages: neptune and management
• Modules: utils
• Classes: Run, Model, MovelVersion, and Project

View client library on GitHub 

R

The Neptune R package includes most of the functionality that is available in the Python library.

You can find most up to date API reference on the CRAN package page .

View project on GitHub 

Integrations

We provide API references for the classes and functions exposed by Neptune integrations with other ML frameworks.

• Apache Airflow
• Catalyst
• Detectron2
• fastai
• Transformers
• Kedro
• Keras
• LightGBM
• Lightning
• Optuna
• Prophet
• PyTorch
• PyTorch Ignite
• Sacred
• scikit-learn
• skorch
• TensorBoard
• XGBoost

Errors, warnings, and other messages

Not foundInvalid, malformed, or unsupportedLimit exceededOther

• ModuleNotFoundError: No module named 'neptune'
• NVML Error: NVML Shared Library Not Found

• X-coordinates (step) must be strictly increasing for series attribute
• Value of float attribute cannot be malformed
• 'Handler' object has no attribute 'append'
• TypeDoesNotSupportAttributeException
• NeptuneUnsupportedType

• NeptuneLimitExceededException
• NeptuneFieldCountLimitExceedException
• Max string attribute length exceeded

• WritingToArchivedProjectException
• Still waiting for the remaining X operations

See also

• System namespace (sys) – explore the basic metadata that is logged for each Neptune object.
• Change the location of the .neptune folder – and how to access the folder from elsewhere in your system.
• Set up a Neptune error handling function
• Help ≫ Debugging options