BaFileSystem

Filesystem API

The BaFileSystem class provides a pythonic file interface to the BOINC AI Hub based on fssepcarrow-up-right.

BaFileSystem

BaFileSystem is based on fsspecarrow-up-right, so it is compatible with most of the APIs that it offers. For more details, check out our guidearrow-up-right and the fsspecโ€™s API Referencearrow-up-right.

class boincai_hub.BaFileSystem

<source>arrow-up-right

( *args**kwargs )

Parameters

  • endpoint (str, optional) โ€” The endpoint to use. If not provided, the default one (https://boincai.comarrow-up-right) is used.

  • token (str, optional) โ€” Authentication token, obtained with BaApi.login method. Will default to the stored token.

Access a remote BOINC AI Hub repository as if were a local file system.

Usage:

Copied

>>> from boincai_hub import BaFileSystem

>>> fs = BaFileSystem()

>>> # List files
>>> fs.glob("my-username/my-model/*.bin")
['my-username/my-model/pytorch_model.bin']
>>> fs.ls("datasets/my-username/my-dataset", detail=False)
['datasets/my-username/my-dataset/.gitattributes', 'datasets/my-username/my-dataset/README.md', 'datasets/my-username/my-dataset/data.json']

>>> # Read/write files
>>> with fs.open("my-username/my-model/pytorch_model.bin") as f:
...     data = f.read()
>>> with fs.open("my-username/my-model/pytorch_model.bin", "wb") as f:
...     f.write(data)

__init__

<source>arrow-up-right

( *argsendpoint: typing.Optional[str] = Nonetoken: typing.Optional[str] = None**storage_options )

resolve_path

<source>arrow-up-right

( path: strrevision: typing.Optional[str] = None )

ls

<source>arrow-up-right

( path: strdetail: bool = Truerefresh: bool = Falserevision: typing.Optional[str] = None**kwargs )

List the contents of a directory.

Last updated