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-2.0.0a2.tar.gz
(37.3 kB
view details)
Built Distribution
pfio-2.0.0a2-py3-none-any.whl
(47.6 kB
view details)
File details
Details for the file pfio-2.0.0a2.tar.gz.
File metadata
- Download URL: pfio-2.0.0a2.tar.gz
- Upload date:
- Size: 37.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1e33fae97051d67d1b6d250b4f2832606bdf3718de21189720c0c4b882f169c |
|
| MD5 | 62005adfdd996dedf035be37878f8285 |
|
| BLAKE2b-256 | 60c8b716689e07816506b40ee37e94c4cc1e4876f86f183439a185533fd42a4f |
File details
Details for the file pfio-2.0.0a2-py3-none-any.whl.
File metadata
- Download URL: pfio-2.0.0a2-py3-none-any.whl
- Upload date:
- Size: 47.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1e95201a1195e73079390aaa36ab0343ba82b194ff195149aa09a247ba227516 |
|
| MD5 | a022d9f56b0dc15a326e86b2f7c46e4e |
|
| BLAKE2b-256 | a0c331eb91b6cee09ea206c35fc3b4cdcf19e09a03e78fd5d659972de5f15a59 |
