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 .
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.5.1.tar.gz
(35.4 kB
view details)
Built Distribution
pfio-2.5.1-py3-none-any.whl
(43.0 kB
view details)
File details
Details for the file pfio-2.5.1.tar.gz.
File metadata
- Download URL: pfio-2.5.1.tar.gz
- Upload date:
- Size: 35.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.13.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ef9908ae5d73ad66e7eb17cd41f9b67e4e48d8d3276a96510798d6ad50a40981 |
|
| MD5 | d889fba64acacb16e0884e9727e620bc |
|
| BLAKE2b-256 | d6225fecda9813c3cc0f8e8640cb551495bbdc86aef4b2bc572f1be94055e66f |
File details
Details for the file pfio-2.5.1-py3-none-any.whl.
File metadata
- Download URL: pfio-2.5.1-py3-none-any.whl
- Upload date:
- Size: 43.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.13.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cf06740bd6b7094611abe0d17cbc02dd334bcf0c8c115212afd2d0a2daccd952 |
|
| MD5 | 697acfcce6c674a4575aaf9f46d542e4 |
|
| BLAKE2b-256 | 3a8e3ea2a204f49e3393bfbc5fd5a3e5939ff52efff5a1d1da83ffa6b25a3e70 |
