Skip to main content

PFN IO library

Project description

PFIO

PFIO is an IO abstraction library developed by PFN, optimized for deep learning training with batteries included. It supports

  • Filesystem API abstraction with unified error semantics,
  • Explicit user-land caching system,
  • IO performance tracing and metrics stats, and
  • Fileset container utilities to save metadata.

Dependency

  • HDFS client and libhdfs for HDFS access
  • CPython >= 3.8

Installation and Document build

Installation

$ git clone https://github.com/pfnet/pfio.git
$ cd pfio
$ pip install .

Documentation

$ cd pfio/docs
$ make html
$ open build/html/index.html

How to use

Please refer to the official document for more information about the usage.

Release

Check the official document for latest release procedure.

Run tests locally:

$ pip install tox
$ tox

Bump version numbers in pfio/version.py .

Push and open a pull request to invoke CI. Once CI passed and the pull request merged, tag a release:

$ git tag -s X.Y.Z
$ git push --tags

Build:

$ rm -rf dist
$ pip3 install --user build
$ python3 -m build

Release to PyPI:

$ python3 -m pip install --user --upgrade twine
$ python3 -m twine upload --repository testpypi dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pfio-2.6.0.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

pfio-2.6.0-py3-none-any.whl (43.1 kB view details)

Uploaded Python 3

File details

Details for the file pfio-2.6.0.tar.gz.

File metadata

  • Download URL: pfio-2.6.0.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for pfio-2.6.0.tar.gz
Algorithm Hash digest
SHA256 c5b25ad0296d20a10b898945d64c5425d48c7b397315d38c6c926f9070d3d426
MD5 d237b62f782f204c752f822cba023dbb
BLAKE2b-256 bf1a972aaf8de96bc21f855ba9113b4e86bb434700fa4a307a1b25544c78fd32

See more details on using hashes here.

File details

Details for the file pfio-2.6.0-py3-none-any.whl.

File metadata

  • Download URL: pfio-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 43.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for pfio-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd50586e763397ebc06c900b517459d79a6a74ee88e1fddd04107fc5dfdae4d0
MD5 5a4cb2a97ba6799b5301d51f6d6be807
BLAKE2b-256 897256290fe21c310da9a40ce91b0b6d576f69051e41f865ef75c40767fdf0c4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page