config

Documentation

Overview

Package config handles loading and resolving nn configuration.

Index

• func DefaultConfigPath() string
• type Config
  • func Load(path string) (*Config, error)
  • func (c *Config) Notebook(name string) (NotebookEntry, error)
• type NotebookEntry

Functions

func DefaultConfigPath

func DefaultConfigPath() string

DefaultConfigPath returns the default path to the nn config file. Respects NN_CONFIG_DIR environment variable for testability.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config holds the full parsed configuration.

func Load

func Load(path string) (*Config, error)

Load parses the config file at path.

func (*Config) Notebook

func (c *Config) Notebook(name string) (NotebookEntry, error)

Notebook returns the notebook entry for the given name. If name is empty, it returns the default notebook.

type NotebookEntry

type NotebookEntry struct {
	Path    string `toml:"path"`
	Backend string `toml:"backend"`
}

NotebookEntry holds the configuration for a single named notebook.