Skip to content

Commit

Permalink
Merge pull request Atharva-Phatak#34 from Atharva-Phatak/pypi-officia…
Browse files Browse the repository at this point in the history
…l-release

Pypi official release
  • Loading branch information
Atharva-Phatak authored Apr 21, 2021
2 parents e79829d + 867d30c commit 36a9ab8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ jobs:
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py sdist bdist_wheel
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
twine upload dist/*
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,22 @@ your models with all the callbacks, metrics, etc

### ***Features***
* _A high-level module for Keras-like training._
* _Off-the-shelf Dataloaders for standard tasks(Classification, Regression, etc)_
* _Callbacks for model checkpoints, early stopping, and much more!_
* _Metrics and much more._
* _Off-the-shelf Pytorch style Datasets/Dataloaders for standard tasks such as **Image classification, Image segmentation,
Text Classification**, etc_
* _**Callbacks** for model checkpoints, early stopping, and much more!_
* _**Metrics** and much more._

Currently, **TorchFlare** supports ***CPU*** and ***GPU*** training. DDP and TPU support will be coming soon!

This library is in its nascent stage. So, there might be breaking changes.
**Note :** ***This library is in its nascent stage. So, there might be breaking changes.***
### ***Getting Started***

The core idea around TorchFlare is the [Experiment](/torchflare/experiments/experiment.py)
class. It handles all the internal stuff like boiler plate code for training,
calling callbacks,metrics,etc. The only thing you need to focus on is creating you PyTorch Model.

Also, there are off-the-shelf dataloaders available for standard tasks, so that you don't
have to worry about creating Pytorch Datasets.
Also, there are off-the-shelf pytorch style datasets/dataloaders available for standard tasks, so that you don't
have to worry about creating Pytorch Datasets/Dataloaders.

Here is an easy-to-understand example to show how Experiment class works.

Expand Down
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.4
0.1.0

0 comments on commit 36a9ab8

Please sign in to comment.