heavyedge-dataset 0.2.0

PyTorch-compatible edge profile dataset API

HeavyEdge-Dataset

Package to load edge profile data as PyTorch dataset.

Usage

HeavyEdge-Dataset provides custom dataset classes which wraps profile data file.

A simple use case to load a list of profiles as two-dimensional coordinates:

from heavyedge import get_sample_path, ProfileData
from heavyedge_dataset import ProfileDataset
with ProfileData(get_sample_path("Prep-Type2.h5")) as file:  # Profile data file object
    data = ProfileDataset(file, 2)[:]

Refer to the package documentation for more information.

Documentation

The manual can be found online:

https://heavyedge-dataset.readthedocs.io

If you want to build the document yourself, get the source code and install with [doc] dependency. Then, go to doc directory and build the document:

$ pip install .[doc]
$ cd doc
$ make html

Document will be generated in build/html directory. Open index.html to see the central page.

Developing

Installation

For development features, you must install the package by pip install -e .[dev].

Testing

Run pytest command to perform unit test.