bayesline.api.equity.UploaderApi.commit

abstract UploaderApi.commit(mode: str, names: list[str] | None = None) → UploadCommitResult

Commits and clears all staged files identified by given names.

Parameters

mode: str

commit mode, one of commit_modes

names: list[str] | None, optional

The names of the staging results to commit. If None will commit all staging results. Names that do not exist will be ignored.

Raises

ValueError

if the given commit mode does not exist

UploadError

if the staged data fails validation (as tested by validate_staging_data)

Returns

UploadCommitResult