Metadata-Version: 2.1
Name: BetterLoader
Version: 0.2.2
Summary: A better PyTorch dataloader
Home-page: https://github.com/BinItAI/BetterLoader
Author: BinIt Inc
Author-email: support@binit.in
License: MIT
Download-URL: https://github.com/BinItAI/BetterLoader/archive/0.1.5.zip
Description: <div align="center">
        
        <img src="https://github.com/BinItAI/BetterLoader/blob/master/docs/static/img/logo_text.png" width="600px">
        
        
        **Making it harder to do easy things, but easier to do harder things with the Pytorch Dataloader**
        
        ---
        
        <p align="center">
          <a href="#about-betterloader">About</a> •
          <a href="#installation">Installation</a> •
          <a href="#usage">Usage</a> •
          <a href="#development">Development</a> •
          <a href="#meta">License</a>
        </p>
        
        [![PyPi Badge](https://img.shields.io/pypi/dm/betterloader?style=for-the-badge)](https://pypi.org/project/BetterLoader/)
        [![PyPi Version](https://img.shields.io/pypi/v/betterloader?style=for-the-badge)](https://pypi.org/project/BetterLoader/)
        [![Github Actions Build Status](https://img.shields.io/github/workflow/status/BinItAI/BetterLoader/Build?style=for-the-badge)](https://img.shields.io/github/workflow/status/BinItAI/BetterLoader/Build?style=for-the-badge)
        [![Issues](https://img.shields.io/github/issues/binitai/betterloader?style=for-the-badge)](https://github.com/BinItAI/BetterLoader/issues)
        [![license](https://img.shields.io/github/license/binitai/betterloader?style=for-the-badge)](https://github.com/BinItAI/BetterLoader/blob/master/LICENSE.txt)
        
        </div>
        
        ---
        
        ## About BetterLoader
        BetterLoader is a hyper-customizable extension of the default PyTorch dataloader class, that allows for custom transformations pre-load and image subset definitions. Use the power of custom index files to maintain only a single copy of a dataset with a fixed, flat file structure, and allow BetterLoader to do all the heavy lifting.
        
        ## Installation
        ```sh
        pip install betterloader
        ```
        
        ## Usage
        BetterLoader allows you to dynamically assign images to labels, load subsets of images conditionally, perform custom pretransforms before loading an image, and much more. 
        
        ### Basic Usage
        A few points worth noting are that:
        - BetterLoader does not expect a nested folder structure. In its current iteration, files are expected to all be present in the root directory.
        - <b>Every</b> instance of BetterLoader requires an index file to function. Sample index files may be found <a href="https://binitai.github.io/BetterLoader/docs/files">here</a>.
        
        ```python
        from betterloader import BetterLoader
        
        index_json = './examples/sample_index.json'
        basepath = "./examples/sample_dataset/"
        batch_size = 2
        
        loader = BetterLoader(basepath=basepath, index_json_path=index_json)
        dataloaders, sizes = loader.fetch_segmented_dataloaders(batch_size=batch_size, transform=None)
        
        print("Dataloader sizes: {}".format(str(sizes)))
        ```
        For more information and more detailed examples, please check out <a href="https://binitai.github.io/BetterLoader/">the BetterLoader docs</a>!
        
        ## Development
        
        We use <a href="https://opensource.com/article/18/8/what-how-makefile">Makefile</a> to make our lives a little easier :)
        ### Install Dependancies
        ```sh
        make install
        ```
        ### Run Sample
        ```sh
        make sample
        ```
        ### Run Unit Tests
        ```sh
        make test
        ```
        
        ## Meta
        Distributed under the MIT license. See ``LICENSE`` for more information.
        
        ## Documentation & Usage
        - [Usage docs](https://binitai.github.io/BetterLoader/)
        - [Example implementation](./examples)
        - [Contributing](./CONTRIBUTING.md)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
