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.1.tar.gz
(37.9 kB
view details)
Built Distribution
pfio-2.0.1-py3-none-any.whl
(49.2 kB
view details)
File details
Details for the file pfio-2.0.1.tar.gz.
File metadata
- Download URL: pfio-2.0.1.tar.gz
- Upload date:
- Size: 37.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04a97104bf7fb944455e4acbb461c9a573a320094e8d9bb66d0e52619fde4bf0 |
|
| MD5 | 74696d22833f90932c0ea1ad90543190 |
|
| BLAKE2b-256 | 27f775fe8dadec42cffb30acd29061bcd6e12f84ab57795cd4c707eee4d67dc0 |
File details
Details for the file pfio-2.0.1-py3-none-any.whl.
File metadata
- Download URL: pfio-2.0.1-py3-none-any.whl
- Upload date:
- Size: 49.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b864501e9bc20c57860b8b68e408dd02a0bbb8b1355455001efc3a96c14fe55b |
|
| MD5 | aee88455dd997b5223d57b9580da5a53 |
|
| BLAKE2b-256 | 5e1470126fc144331275d6ff47b30edf202ae18e0b954a43c8cb0f1e59f33d4d |
