Skip to content

Commit

Permalink
Update demo links, logo and add literature references, reformat.
Browse files Browse the repository at this point in the history
  • Loading branch information
salgadev committed Sep 23, 2023
1 parent dde8926 commit 0267c3a
Showing 1 changed file with 14 additions and 27 deletions.
41 changes: 14 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# mezcal
# SpiritVision

[![train-resnet18](https://github.com/socd06/mezcal/actions/workflows/cml.yml/badge.svg)](https://github.com/socd06/mezcal/actions/workflows/cml.yml)
Multi-Class Image Classification of evaporated mezcal drops using OpenCv, PyTorch and fastai. Web App deployed
on [HuggingFace Spaces](https://huggingface.co/spaces/salgadev/spiritvision-demo).

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/socd06/mezcal/HEAD?urlpath=%2Fvoila%2Frender%2Fapp.ipynb)

Multi-Class Image Classification of evaporated mezcal drops using fastai and PyTorch. Web App deployed
on [Binder](https://mybinder.org/v2/gh/socd06/mezcal/HEAD?urlpath=%2Fvoila%2Frender%2Fapp.ipynb).

<img src="icon.png" alt="Agave plant icon" style="height: 240px; width:300px;"/>
<img src="logo23.png" alt="Agave plant icon" style="height: 240px; width:300px;"/>

## Background

Expand All @@ -24,18 +20,20 @@ mezcal types using image classification models trained in evaporated mezcal drop

## Technologies used

Python, fastai, PyTorch, scikit-learn, Voilà
- [OpenCV](https://opencv.org/)
- [PyTorch](https://pytorch.org/)
- [fastai](https://www.fast.ai/)

## Getting Started
## Local Setup

1. Get and install [Python](https://www.python.org/downloads/) and an IDE of your choice
(e.g. [PyCharm](https://www.jetbrains.com/pycharm/download/) or [Spyder](https://www.spyder-ide.org/))
2. Make a virtual environment -- *will depend on your IDE* -- (Optional)
3. Install dependencies using the terminal
3. Install dependencies, for example, using the terminal
```
pip install -r requirements.txt
```
4. Try out the Jupyter Notebooks and/or the training script
4. Try the Notebooks directory and/or the training script

## Collaborating

Expand All @@ -47,18 +45,7 @@ Python, fastai, PyTorch, scikit-learn, Voilà
- Contact [Carlos](mailto:csalgado@uwo.ca) or [Angel](mailto:Angel.reyes@cimat.mx) if you would like to be invited to
the Discord chat

## References:

- [Revisión del Agave y el Mezcal](https://www.redalyc.org/journal/776/77645907016/)

## torchserve
Archive model like so
```torch-model-archiver --model-name mezcalvision --version 0.1 --model-file .\model.py --serialized-file .\models\resnet_50_2023May08_0614PM.pt --handler image_classifier --extra-files ./index_to_name.
json
```

Deploy with the following command:
```
torchserve --start --model-store model_store --models mezcalvision=mezcalvision.mar --ncs
```

## References
- [NOM-070-SCFI-2016, Bebidas alcohólicas-Mezcal-Especificaciones](https://dof.gob.mx/nota_detalle.php?codigo=5472787&fecha=23/02/2017#gsc.tab=0)
- [Revisión del Agave y el Mezcal](https://www.redalyc.org/journal/776/77645907016/)
- [VOLATILE COMPONENTS IN MEZCAL - Revista Mexicana de Ingeniería Química](https://www.redalyc.org/pdf/620/62060106.pdf)

1 comment on commit 0267c3a

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current Requirements

fastbook
fastai
scikit-learn
jupyterlab
matplotlib
opencv-python~=4.6.0.66
torch
torchvision
numpyaiohttp==3.8.5
aiosignal==1.3.1
annotated-types==0.5.0
anyio==4.0.0
argcomplete==3.1.2
argon2-cffi==23.1.0
argon2-cffi-bindings==21.2.0
arrow==1.2.3
asttokens==2.4.0
async-lru==2.0.4
async-timeout==4.0.3
attrs==23.1.0
Automat==20.2.0
Babel==2.12.1
backcall==0.2.0
bcrypt==3.2.0
beautifulsoup4==4.12.2
bleach==6.0.0
blinker==1.4
blis==0.7.11
catalogue==2.0.9
certifi==2020.6.20
cffi==1.15.1
chardet==4.0.0
charset-normalizer==3.2.0
click==8.0.3
cloud-init==23.2.2
cmake==3.27.5
colorama==0.4.4
comm==0.1.4
command-not-found==0.3
confection==0.1.3
configobj==5.0.6
constantly==15.1.0
contourpy==1.1.1
cryptography==3.4.8
cycler==0.11.0
cymem==2.0.8
datasets==2.14.5
dbus-python==1.2.18
debugpy==1.8.0
decorator==5.1.1
defusedxml==0.7.1
dill==0.3.7
distro==1.7.0
distro-info==1.1+ubuntu0.1
exceptiongroup==1.1.3
executing==1.2.0
fastai==2.7.12
fastbook==0.0.29
fastcore==1.5.29
fastdownload==0.0.7
fastjsonschema==2.18.0
fastprogress==1.0.3
filelock==3.12.4
fonttools==4.42.1
fqdn==1.5.1
frozenlist==1.4.0
fsspec==2023.6.0
graphviz==0.20.1
httplib2==0.20.2
huggingface-hub==0.17.2
hyperlink==21.0.0
idna==3.3
importlib-metadata==4.6.4
incremental==21.3.0
ipykernel==6.25.2
ipython==8.15.0
ipython-genutils==0.2.0
ipywidgets==7.8.1
isoduration==20.11.0
jedi==0.19.0
jeepney==0.7.1
Jinja2==3.0.3
joblib==1.3.2
json5==0.9.14
jsonpatch==1.32
jsonpointer==2.0
jsonschema==4.19.1
jsonschema-specifications==2023.7.1
jupyter-events==0.7.0
jupyter-lsp==2.2.0
jupyter_client==8.3.1
jupyter_core==5.3.1
jupyter_server==2.7.3
jupyter_server_terminals==0.4.4
jupyterlab==4.0.6
jupyterlab-pygments==0.2.2
jupyterlab-widgets==1.1.7
jupyterlab_server==2.25.0
keyring==23.5.0
kiwisolver==1.4.5
langcodes==3.3.0
launchpadlib==1.10.16
lazr.restfulclient==0.14.4
lazr.uri==1.0.6
lit==16.0.6
MarkupSafe==2.0.1
matplotlib==3.8.0
matplotlib-inline==0.1.6
mercurial==6.1.1
mistune==3.0.1
more-itertools==8.10.0
mpmath==1.3.0
multidict==6.0.4
multiprocess==0.70.15
murmurhash==1.0.10
nbclient==0.8.0
nbconvert==7.8.0
nbformat==5.9.2
nest-asyncio==1.5.8
netifaces==0.11.0
networkx==3.1
notebook==7.0.4
notebook_shim==0.2.3
numpy==1.26.0
nvidia-cublas-cu11==11.10.3.66
nvidia-cuda-cupti-cu11==11.7.101
nvidia-cuda-nvrtc-cu11==11.7.99
nvidia-cuda-runtime-cu11==11.7.99
nvidia-cudnn-cu11==8.5.0.96
nvidia-cufft-cu11==10.9.0.58
nvidia-curand-cu11==10.2.10.91
nvidia-cusolver-cu11==11.4.0.1
nvidia-cusparse-cu11==11.7.4.91
nvidia-nccl-cu11==2.14.3
nvidia-nvtx-cu11==11.7.91
oauthlib==3.2.0
opencv-python==4.6.0.66
overrides==7.4.0
packaging==23.1
pandas==2.1.1
pandocfilters==1.5.0
parso==0.8.3
pathy==0.10.2
pexpect==4.8.0
pickleshare==0.7.5
Pillow==10.0.1
pipx==1.2.0
platformdirs==3.10.0
preshed==3.0.9
prometheus-client==0.17.1
prompt-toolkit==3.0.39
psutil==5.9.5
ptyprocess==0.7.0
pure-eval==0.2.2
pyarrow==13.0.0
pyasn1==0.4.8
pyasn1-modules==0.2.1
pycparser==2.21
pydantic==2.3.0
pydantic_core==2.6.3
Pygments==2.11.2
PyGObject==3.42.1
PyHamcrest==2.0.2
PyJWT==2.3.0
pyOpenSSL==21.0.0
pyparsing==2.4.7
pyparted==3.11.7
pyrsistent==0.18.1
pyserial==3.5
python-apt==2.4.0+ubuntu2
python-dateutil==2.8.2
python-debian==0.1.43+ubuntu1.1
python-json-logger==2.0.7
python-magic==0.4.24
pytz==2022.1
PyYAML==5.4.1
pyzmq==25.1.1
referencing==0.30.2
regex==2023.8.8
requests==2.31.0
rfc3339-validator==0.1.4
rfc3986-validator==0.1.1
rpds-py==0.10.3
safetensors==0.3.3
scikit-learn==1.3.1
scipy==1.11.2
SecretStorage==3.3.1
Send2Trash==1.8.2
sentencepiece==0.1.99
service-identity==18.1.0
six==1.16.0
smart-open==6.4.0
sniffio==1.3.0
sos==4.5.6
soupsieve==2.5
spacy==3.6.1
spacy-legacy==3.0.12
spacy-loggers==1.0.5
srsly==2.4.8
ssh-import-id==5.11
stack-data==0.6.2
sympy==1.12
systemd-python==234
terminado==0.17.1
thinc==8.1.12
threadpoolctl==3.2.0
tinycss2==1.2.1
tokenizers==0.13.3
tomli==2.0.1
torch==2.0.1
torchvision==0.15.2
tornado==6.3.3
tqdm==4.66.1
traitlets==5.10.0
transformers==4.33.2
triton==2.0.0
Twisted==22.1.0
typer==0.9.0
typing_extensions==4.8.0
tzdata==2023.3
ubuntu-advantage-tools==8001
ufw==0.36.1
uri-template==1.3.0
urllib3==1.26.5
userpath==1.9.1
wadllib==1.3.6
WALinuxAgent==2.2.46
wasabi==1.1.2
wcwidth==0.2.6
webcolors==1.13
webencodings==0.5.1
websocket-client==1.6.3
widgetsnbextension==3.6.6
xxhash==3.3.0
yarl==1.9.2
zipp==1.0.0
zope.interface==5.4.0

Please sign in to comment.