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.6
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
Test
$ cd pfio
$ pip install .[test]
$ pytest tests/
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 --user -e .[test]
$ pytest
Bump version numbers in pfio/version.py and in docs/source/conf.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/*
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pfio-1.6.0.tar.gz
(35.0 kB
view details)
Built Distribution
pfio-1.6.0-py3-none-any.whl
(47.4 kB
view details)
File details
Details for the file pfio-1.6.0.tar.gz.
File metadata
- Download URL: pfio-1.6.0.tar.gz
- Upload date:
- Size: 35.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 130ee1d595a7f52a3c6a1e3e22859548fc63432841028f97022fa58118ff1978 |
|
| MD5 | 1991c5f4367bd59681a60bfbf87790ad |
|
| BLAKE2b-256 | 1bc02a5f1c34fb6767ecea894cf3a687b6e209b40d723f8e484b2dc0264df111 |
File details
Details for the file pfio-1.6.0-py3-none-any.whl.
File metadata
- Download URL: pfio-1.6.0-py3-none-any.whl
- Upload date:
- Size: 47.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c18c9007b872505baec007da8534e832d5d7d5c136108df085b22214cc657ee |
|
| MD5 | b971e6580b0814855febc7b2bf54be31 |
|
| BLAKE2b-256 | 68997e00929c8a08cd5228b318f529ba82dacbd3dc3c7dc98fd7f6163e997d65 |
