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.0rc1.tar.gz
(34.6 kB
view details)
Built Distribution
pfio-2.4.0rc1-py3-none-any.whl
(42.1 kB
view details)
File details
Details for the file pfio-2.4.0rc1.tar.gz.
File metadata
- Download URL: pfio-2.4.0rc1.tar.gz
- Upload date:
- Size: 34.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0cebc01bf46168508a7f03dc8f00f4ce72298a2c9ca226947fd7b76efd085775 |
|
| MD5 | 294411d03ca592bc20134a989b6d6e8e |
|
| BLAKE2b-256 | cd366ed5b576efdd145f62e0b7db6cc39ee3113e7268a47c53ca2a8584c65e23 |
File details
Details for the file pfio-2.4.0rc1-py3-none-any.whl.
File metadata
- Download URL: pfio-2.4.0rc1-py3-none-any.whl
- Upload date:
- Size: 42.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f19a953f482d330af263eaabb63225fa47650e7cb0500d9c01ec7041e6bce68 |
|
| MD5 | d03dee9f2e716596bdc1c3bc21df7da2 |
|
| BLAKE2b-256 | 5b634055fd96ad92b593175f7fe6356519acae04e32aaa78f3b478a5863f2144 |
