Module `livelossplot.outputs.neptune_logger`

Expand source code

from typing import Optional
from livelossplot.main_logger import MainLogger
from livelossplot.outputs.base_output import BaseOutput


class NeptuneLogger(BaseOutput):
    """See: https://github.com/neptune-ai/neptune-client
    YOUR_API_TOKEN and USERNAME/PROJECT_NAME
    """
    def __init__(self, api_token: Optional[str] = None, project_qualified_name: Optional[str] = None, **kwargs):
        """Set secrets and create experiment
        Args:
            api_token: your api token, you can create NEPTUNE_API_TOKEN environment variable instead
            project_qualified_name: <user>/<project>, you can create NEPTUNE_PROJECT environment variable instead
            **kwargs: keyword args, that will be passed to create_experiment function
        """
        import neptune
        self.neptune = neptune
        self.neptune.init(api_token=api_token, project_qualified_name=project_qualified_name)
        self.experiment = self.neptune.create_experiment(**kwargs)

    def close(self):
        """Close connection"""
        self.neptune.stop()

    def send(self, logger: MainLogger):
        """Send metrics collected in last step to neptune server"""
        for name, log_items in logger.log_history.items():
            last_log_item = log_items[-1]
            self.neptune.send_metric(name, x=last_log_item.step, y=last_log_item.value)

Classes

class NeptuneLogger (api_token: Optional[str] = None, project_qualified_name: Optional[str] = None, **kwargs)

See: https://github.com/neptune-ai/neptune-client YOUR_API_TOKEN and USERNAME/PROJECT_NAME

Set secrets and create experiment

Args

api_token: your api token, you can create NEPTUNE_API_TOKEN environment variable instead
project_qualified_name: /, you can create NEPTUNE_PROJECT environment variable instead
**kwargs: keyword args, that will be passed to create_experiment function

Expand source code

class NeptuneLogger(BaseOutput):
    """See: https://github.com/neptune-ai/neptune-client
    YOUR_API_TOKEN and USERNAME/PROJECT_NAME
    """
    def __init__(self, api_token: Optional[str] = None, project_qualified_name: Optional[str] = None, **kwargs):
        """Set secrets and create experiment
        Args:
            api_token: your api token, you can create NEPTUNE_API_TOKEN environment variable instead
            project_qualified_name: <user>/<project>, you can create NEPTUNE_PROJECT environment variable instead
            **kwargs: keyword args, that will be passed to create_experiment function
        """
        import neptune
        self.neptune = neptune
        self.neptune.init(api_token=api_token, project_qualified_name=project_qualified_name)
        self.experiment = self.neptune.create_experiment(**kwargs)

    def close(self):
        """Close connection"""
        self.neptune.stop()

    def send(self, logger: MainLogger):
        """Send metrics collected in last step to neptune server"""
        for name, log_items in logger.log_history.items():
            last_log_item = log_items[-1]
            self.neptune.send_metric(name, x=last_log_item.step, y=last_log_item.value)

Ancestors

BaseOutput
abc.ABC

Methods

def close(self)

Close connection

Expand source code

def close(self):
    """Close connection"""
    self.neptune.stop()

def send(self, logger: MainLogger)

Send metrics collected in last step to neptune server

Expand source code

def send(self, logger: MainLogger):
    """Send metrics collected in last step to neptune server"""
    for name, log_items in logger.log_history.items():
        last_log_item = log_items[-1]
        self.neptune.send_metric(name, x=last_log_item.step, y=last_log_item.value)

Inherited members

BaseOutput:
- set_output_mode