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.4.1.tar.gz
(35.5 kB
view details)
Built Distribution
pfio-1.4.1-py3-none-any.whl
(46.6 kB
view details)
File details
Details for the file pfio-1.4.1.tar.gz.
File metadata
- Download URL: pfio-1.4.1.tar.gz
- Upload date:
- Size: 35.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 47f47aaa551df86e18abe4068b2b4012c7a977987926cfd31e267fb9ce6d0547 |
|
| MD5 | c8ef0d82d8bc4cf1b1c50f2c05c42402 |
|
| BLAKE2b-256 | cde2300a7e683f430911b983c25965d46298b54c62425782da8874ce0da4a26b |
File details
Details for the file pfio-1.4.1-py3-none-any.whl.
File metadata
- Download URL: pfio-1.4.1-py3-none-any.whl
- Upload date:
- Size: 46.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d917ea22dd67d82d63c65701f6ac7bb64913a08c2702e7550153dc4b34dc2eb9 |
|
| MD5 | 499a64a92ab3d098e47586ed881d6bdf |
|
| BLAKE2b-256 | 3163d1fdf8205c9692566533f29d081b90dbbafe00dd233c402eb65c7950418f |
