Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add streamlit readme #168

Merged
merged 24 commits into from
Jul 12, 2020
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
16b5468
Merge pull request #1 from lgvaz/master
oke-aditya Jun 9, 2020
c0ec8d5
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 12, 2020
78dce2f
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 15, 2020
8ad6521
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 16, 2020
53bcdae
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 17, 2020
bef81c0
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 18, 2020
c73a2be
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 18, 2020
2436deb
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 19, 2020
22b42c6
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 20, 2020
7557d0f
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 21, 2020
6c032aa
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 23, 2020
d5e0e81
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 23, 2020
cba4ed9
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 23, 2020
a9fcfa8
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 25, 2020
436428d
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 27, 2020
cfc520e
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jun 29, 2020
5bca0d2
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 1, 2020
e8feb0c
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 3, 2020
9c30d74
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 7, 2020
9abe9a5
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 8, 2020
030b1fa
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 9, 2020
c75119c
Merge branch 'master' of https://github.com/lgvaz/mantisshrimp
oke-aditya Jul 10, 2020
ac920c8
Added streamlit demo
oke-aditya Jul 10, 2020
9e8111f
added installtation suggestions
oke-aditya Jul 11, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,27 @@ Quick Example: How to train the **PETS Dataset**
trainer = Trainer(max_epochs=3, gpus=1)
trainer.fit(light_model, train_dl, valid_dl)

Streamlit Demo
--------------
We provide a nice demo using `streamlit`_.
If streamlit is not already install, run the following command, from the terminal to install it:

.. code:: bash

pip install streamlit

Simply run the following in your terminal. It should start a demo in your browser.
It will show you one of our trained models as a pet detector !!

.. code:: bash

streamlit run https://raw.githubusercontent.com/oke-aditya/mantisshrimp_streamlit/master/app.py

`This`_ is the source code for the demo.

You can also use it as template when creating your own streamlit apps with mantisshrimp.


Contributing
------------
Check out our `contributing guide`_.
Expand All @@ -276,7 +297,8 @@ Be sure to check the `documentation`_.
.. _here: https://pytorch.org/get-started/locally/#start-locally
.. _issue-185: https://github.com/cocodataset/cocoapi/issues/185
.. _Docker website: https://docs.docker.com/engine/install/

.. _This: https://github.com/oke-aditya/mantisshrimp_streamlit
.. _streamlit: https://www.streamlit.io/
.. |tests| image:: https://github.com/lgvaz/mantisshrimp/workflows/tests/badge.svg?event=push
:target: https://github.com/lgvaz/mantisshrimp/actions?query=workflow%3Atests
.. |codecov| image:: https://codecov.io/gh/lgvaz/mantisshrimp/branch/master/graph/badge.svg
Expand Down