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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pfio-2.7.0.tar.gz
  • Upload date:
  • Size: 39.8 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.0.tar.gz
Algorithm Hash digest
SHA256 de52b174905b418270c428812952c0925c87f225464bf30988b762de55fb7287
MD5 d479d806f151a02e92176e0ec7b7ba87
BLAKE2b-256 f16a30ff5febb48f1a740a4a0e5bca4dd72852d368835fc699de9e2f36ed2872

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pfio-2.7.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61ec4ebf184062a4e0d756407d6afbada1cd316172dbce3e886d5911abfa5e2d
MD5 aa7b5528d054b44939255d2ae2696e80
BLAKE2b-256 2028d9d38b420bb1930df3244d0318f5fe49cb0084d185111286ad02394ff3ea

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