scalarstop.exceptions

Every custom ScalarStop exception.

Module Contents

exception ScalarStopException

Bases: Exception

Base class for all ScalarStop exceptions.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception InconsistentCachingParameters

Bases: ValueError, ScalarStopException

Raised when DataBlob.cache() is set with inconsistent parameters.

An example of setting inconsistent parameters is when the user says training=False and preload_training=True.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception YouForgotTheHyperparams(class_name: str)

Bases: ValueError, ScalarStopException

Raised when the user creates a class, but forgets to add a nested Hyperparams class.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception WrongHyperparamsType(*, hyperparams: Any, class_name: str)

Bases: TypeError, ScalarStopException

Raised when the user passes an object with the wrong type as hyperparams.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception DataBlobNotFound(path: str)

Bases: FileNotFoundError, ScalarStopException

Raised when we cannot load a DataBlob from the filesystem.

Parameters

path – The directory that we went looking for the DataBlob when we were not able to find it.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception ModelNotFoundError(directory: str)

Bases: FileNotFoundError, ScalarStopException

Raised when we cannot find a saved model.

Initialize self. See help(type(self)) for accurate signature.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception FileExists

Bases: FileExistsError, ScalarStopException

Raise when we want to save a DataBlob but a file exists at the save path

Initialize self. See help(type(self)) for accurate signature.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception FileExistsDuringDataBlobCreation

Bases: FileExists

Raised when a file exists at the save path, but we think the file was created while we were saving the DataBlob, which suggests that the user’s code has a race conditon.

Initialize self. See help(type(self)) for accurate signature.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception TensorFlowDatasetNotFound(directory: str)

Bases: FileNotFoundError, ScalarStopException

Raised when we canno load a tf.data.Dataset from the filesystem.

Initialize self. See help(type(self)) for accurate signature.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception ElementSpecNotFound(directory: str)

Bases: FileNotFoundError, ScalarStopException

Raised when we try to guess the location of a serialized element_spec for a tf.data.Dataset.

Parameters

directory – The directory where we were looking for the element_spec for a tf.data.Dataaset. The TensorFlow API assumes that you have the element_spec on hand, but ScalarStop likes to save it to disk.

class args

class characters_written

class errno

POSIX exception code

class filename

exception filename

class filename2

second exception filename

class strerror

exception strerror

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception IsNotImplemented(name: str)

Bases: NotImplementedError, ScalarStopException

Raised when someone calls a function that isn’t yet implemented.

Parameters

name – The name of the function, method, or property that was not implemented. This is useful in case the stack trace is hard to read for some reason.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception SQLite_JSON_ModeDisabled

Bases: RuntimeError, ScalarStopException

Raised when the user is running the TrainStore backed by a SQLite database, but the SQLite JSON1 extension is unavailable.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception UnsupportedDataBlobSaveLoadVersion(*, version: int)

Bases: ScalarStopException

Raised when we don’t recognize the Load/Save version number.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception DataBlobShardingNotSupported(*, version: int, offset: Optional[int], quantity: int, total_num_shards: int)

Bases: ScalarStopException

Raised when the user tries to shard a saved DataBlob and the Load/Save version is too old.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception DataBlobShardingValueError

Bases: ValueError, ScalarStopException

Raised when sharding parameters are not correct.

Initialize self. See help(type(self)) for accurate signature.

class args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.