settings

package
v0.0.0-...-e5597af Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 1, 2024 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Defines W&B settings.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Settings

type Settings struct {

	// The source proto.
	//
	// DO NOT ADD USAGES. Used to refactor incrementally.
	Proto *service.Settings
}

Settings for the SDK.

This is derived from the Settings proto and adapted for use in Go.

func From

func From(proto *service.Settings) *Settings

Parses the Settings proto into a Settings object.

func (*Settings) EnsureAPIKey

func (s *Settings) EnsureAPIKey() error

Ensures the APIKey is set if it needs to be.

Reads the API key from .netrc if it's not already set.

func (*Settings) GetAPIKey

func (s *Settings) GetAPIKey() string

The W&B API key.

This can be empty if we're in offline mode.

func (*Settings) GetEntity

func (s *Settings) GetEntity() string

The W&B entity, like a user or a team.

func (*Settings) GetFilesDir

func (s *Settings) GetFilesDir() string

The local directory where the run's files are stored.

func (*Settings) GetIgnoreGlobs

func (s *Settings) GetIgnoreGlobs() []string

Unix glob patterns relative to `files_dir` to not upload.

func (*Settings) GetInternalLogFile

func (s *Settings) GetInternalLogFile() string

Filename to use for internal logs.

func (*Settings) GetLogDir

func (s *Settings) GetLogDir() string

The directory for storing log files.

func (*Settings) GetProject

func (s *Settings) GetProject() string

The W&B project ID.

func (*Settings) GetRunID

func (s *Settings) GetRunID() string

The ID of the run.

func (*Settings) GetRunURL

func (s *Settings) GetRunURL() string

The W&B URL where the run can be viewed.

func (*Settings) IsOffline

func (s *Settings) IsOffline() bool

Whether we are in offline mode.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL