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.5.0.tar.gz
(36.2 kB
view details)
Built Distribution
pfio-1.5.0-py3-none-any.whl
(47.2 kB
view details)
File details
Details for the file pfio-1.5.0.tar.gz.
File metadata
- Download URL: pfio-1.5.0.tar.gz
- Upload date:
- Size: 36.2 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 | 9bdcc5544fd9c185f4ec4b27e368470d7e1b85b812c78d8a6b1db747620b0a2d |
|
| MD5 | c49ae55902db530d849e0609f071b300 |
|
| BLAKE2b-256 | 480b1bf8227560d002c762e34f3da5e07f6271b06ea94b50eaae2dd8bb1c8fa3 |
File details
Details for the file pfio-1.5.0-py3-none-any.whl.
File metadata
- Download URL: pfio-1.5.0-py3-none-any.whl
- Upload date:
- Size: 47.2 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 | 08c85c1b1710f90a052da96bb303e1731a53f4684dcf8eca533944cc70804727 |
|
| MD5 | 04881ed8ba4816c938ce2f079141c444 |
|
| BLAKE2b-256 | c739c7647268554e5e04192376c4394993230d57bb5e221c4812ce9f4a5e078e |
