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

Uploaded Source

Built Distribution

pfio-2.7.1-py3-none-any.whl (48.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pfio-2.7.1.tar.gz
Algorithm Hash digest
SHA256 806a0d2ba65913cbf5e368ccb7c947f2672ca0202651853e3e579a457510b829
MD5 1cae0af7a19ef1214c0870abf4329263
BLAKE2b-256 766d4b809348224175ee620d61e3b03a0bd76254f7faba23cf6b16fe1649e729

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pfio-2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 63bce6bf5d26bd25bbde1e670fe07188b4c0d34cb71926aaf2c670c56cbd5799
MD5 e1c60fde1a2ea168b26de0ff1221276e
BLAKE2b-256 1e1ae0dd54bf28c52f62e82c50014235b8b607326cf2718e1b29307a73c9ce13

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