Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ancestor-mithril authored Jul 30, 2024
1 parent 11be404 commit d72572f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ A Batch Size Scheduler library compatible with PyTorch DataLoaders.

Documentation: [API Reference](https://ancestor-mithril.github.io/bs_scheduler/).

Examples: TODO.
<!--Examples: TODO. -->

<!--For Release Notes, see TODO. -->

## Why use a Batch Size Scheduler?

TODO: Cite papers and explain why.
<!--TODO: Cite papers and explain why. -->

## Available Schedulers

Expand Down Expand Up @@ -41,10 +41,14 @@ TODO: Cite papers and explain why.
scheduler should be called when.
15. `ChainedBSScheduler` - chains a list of batch size schedulers and calls them together each step.

<!--
## Quick Start
TODO.
-->

## Installation

Please install [PyTorch](https://github.com/pytorch/pytorch) first before installing this repository.
Expand All @@ -63,4 +67,4 @@ pip install git+https://github.com/ancestor-mithril/bs_scheduler.git@master

The library is licensed under the [BSD-3-Clause license](LICENSE).

Citation: TODO.
<!--Citation: TODO. -->

0 comments on commit d72572f

Please sign in to comment.