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.4.0.tar.gz
(34.7 kB
view details)
Built Distribution
pfio-2.4.0-py3-none-any.whl
(42.0 kB
view details)
File details
Details for the file pfio-2.4.0.tar.gz.
File metadata
- Download URL: pfio-2.4.0.tar.gz
- Upload date:
- Size: 34.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/5.0.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eedc5d89347c4afe329c14ee0e5f5883131355bd55b98c1642682f41a7f74be0 |
|
| MD5 | da3de1ae1903912adda2f7be7dc15484 |
|
| BLAKE2b-256 | 7fbac42a98131e69d3f1ba00ee60a3179b6e97d748c6be938dfcb7942da8ab66 |
File details
Details for the file pfio-2.4.0-py3-none-any.whl.
File metadata
- Download URL: pfio-2.4.0-py3-none-any.whl
- Upload date:
- Size: 42.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/5.0.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 79d18705473a2cac87ef74c2dd0c225011d3af63879c355f75af525cf768e4c1 |
|
| MD5 | 301e62058dd3bf13b55ceaf6bd18f4af |
|
| BLAKE2b-256 | d12ce103295f423f25078b9a2dc2c9eb4ead6019395d1c3390bb8441caa8e4f2 |
