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.3.tar.gz
(35.3 kB
view details)
Built Distribution
pfio-1.4.3-py3-none-any.whl
(46.2 kB
view details)
File details
Details for the file pfio-1.4.3.tar.gz.
File metadata
- Download URL: pfio-1.4.3.tar.gz
- Upload date:
- Size: 35.3 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.61.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d3c07995d05dd2c912ed5e9d0a4122b7dd050e18cb10a567c9e1c6399765f4b1 |
|
| MD5 | eb474c613530365fce0cd5f709f43a72 |
|
| BLAKE2b-256 | ce0dc0d28c641432ce5f3b5eebb66a863ce7e3a740ad1057c91edc96e123bdd4 |
File details
Details for the file pfio-1.4.3-py3-none-any.whl.
File metadata
- Download URL: pfio-1.4.3-py3-none-any.whl
- Upload date:
- Size: 46.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.61.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb1ed4a386dc58ebd67dd382ba544fcfa7331e2607548a90d196b422494ba78d |
|
| MD5 | fb7ff95731e6da646c52ca755fb51ecb |
|
| BLAKE2b-256 | bb7628f21687a5c1d0dd7108a876ed0cfb183e66f547f2baef2365ddd338f3f8 |
