Skip to main content

PFN IO library

Project description

PFIO

Doc Status Badge

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.8.0.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

pfio-2.8.0-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pfio-2.8.0.tar.gz
Algorithm Hash digest
SHA256 7f609549fc688a82c416f1c9edd5b0fcbe1e6ab469b737d858f026fa5e4586cf
MD5 bc416efb77c66fba382e496c645aa058
BLAKE2b-256 20f1e99bda28b4dab8901ce07d17c33d58f05aeeed138e5853d6813b24455474

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pfio-2.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b70596f683cb316da385299d137de29fe972cfde448f495c60203de77c4dc5f
MD5 6494ae16e7b0a09f5123e94c98a5826f
BLAKE2b-256 927a6ecd508d28d8804a67fea4724d887924884f26a660cb79de5a6f671a2090

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