aistore.sdk.archive_config

View as Markdown

Module Contents

Classes

NameDescription
ArchiveConfigConfiguration for extracting files from an archive
ArchiveModeArchive mode for getting files/objects from an archive in a bucket

API

class aistore.sdk.archive_config.ArchiveConfig(
archpath: str = '',
regex: str = '',
mode: aistore.sdk.archive_config.ArchiveMode = None
)
Dataclass

Configuration for extracting files from an archive

archpath (str, optional): If the object is an archive, use archpath to extract a single file from the archive regex (str, optional): A prefix, suffix, WebDataset key, or general-purpose regular expression used to match filenames within the archive and select possibly multiple files mode (ArchiveMode, optional): Specifies the mode of archive extraction when using regex

archpath
str = ''
mode
ArchiveMode = None
regex
str = ''
aistore.sdk.archive_config.ArchiveConfig.__post_init__()
class aistore.sdk.archive_config.ArchiveMode

Bases: enum.Enum

Archive mode for getting files/objects from an archive in a bucket See MatchMode enum in the cmn/archive/read.go

PREFIX
= 'prefix'
REGEXP
= 'regexp'
SUBSTR
= 'substr'
SUFFIX
= 'suffix'
WDSKEY
= 'wdskey'