initial commit

.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+Thank you for contributing!
+Before submitting this PR, please make sure:
+
+- [ ] Your code builds clean without any errors or warnings
+- [ ] Your code doesn't break anything we can't fix
+- [ ] You have added appropriate tests
+
+Please check one or more of the following to describe the nature of this PR:
+- [ ] New feature
+- [ ] Bug fix
+- [ ] Documentation
+- [ ] Other

.github/workflows/check-file-size-limit.yml

@@ -0,0 +1,14 @@
+name: 10 MB file size limit
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  check-file-sizes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check large files
+        uses: ActionsDesk/lfs-warning@v2.0
+        with:
+          filesizelimit: 10485760 # this is 10MB so we can sync to HF Spaces
+          token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}

.github/workflows/hf-space.yml

@@ -0,0 +1,21 @@
+name: Push to HuggingFace Space
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  push-to-huggingface:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
+
+    - name: Push to HuggingFace Space
+      env:
+        HF_TOKEN: ${{ secrets.HF_TOKEN }}
+      run: |
+        git push https://joshuasundance:$HF_TOKEN@huggingface.co/spaces/joshuasundance/mtg-coloridentity main

.gitignore

@@ -0,0 +1,94 @@
+hf_cache/
+govgis-nov2023/
+*$py.class
+*.chainlit
+*.chroma
+*.cover
+*.egg
+*.egg-info/
+*.env
+*.langchain.db
+*.log
+*.manifest
+*.mo
+*.pot
+*.py,cover
+*.py[cod]
+*.sage.py
+*.so
+*.spec
+.DS_STORE
+.Python
+.cache
+.coverage
+.coverage.*
+.dmypy.json
+.eggs/
+.env
+.hypothesis/
+.idea
+.installed.cfg
+.ipynb_checkpoints
+.mypy_cache/
+.nox/
+.pyre/
+.pytest_cache/
+.python-version
+.ropeproject
+.ruff_cache/
+.scrapy
+.spyderproject
+.spyproject
+.tox/
+.venv
+.vscode
+.webassets-cache
+/site
+ENV/
+MANIFEST
+__pycache__
+__pycache__/
+__pypackages__/
+build/
+celerybeat-schedule
+celerybeat.pid
+coverage.xml
+credentials.json
+data/
+db.sqlite3
+db.sqlite3-journal
+develop-eggs/
+dist/
+dmypy.json
+docs/_build/
+downloads/
+eggs/
+env.bak/
+env/
+fly.toml
+htmlcov/
+instance/
+ipython_config.py
+junk/
+lib/
+lib64/
+local_settings.py
+models/*.bin
+nosetests.xml
+lab/scratch/
+lab/
+parts/
+pip-delete-this-directory.txt
+pip-log.txt
+pip-wheel-metadata/
+profile_default/
+sdist/
+share/python-wheels/
+storage
+target/
+token.json
+var/
+venv
+venv.bak/
+venv/
+wheels/

.pre-commit-config.yaml

@@ -0,0 +1,65 @@
+# Don't know what this file is? See https://pre-commit.com/
+#   pip install pre-commit
+#   pre-commit install
+#   pre-commit autoupdate
+# Apply to all files without commiting:
+#   pre-commit run --all-files
+#   I recommend running this until you pass all checks, and then commit.
+#   Fix what you need to and then let the pre-commit hooks resolve their conflicts.
+#   You may need to git add -u between runs.
+exclude: "AI_CHANGELOG.md"
+repos:
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.1.15"
+    hooks:
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix, --ignore, E501]
+-   repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.9.0
+    hooks:
+    -   id: shellcheck
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: check-ast
+    -   id: check-builtin-literals
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-toml
+    -   id: check-xml
+    -   id: debug-statements
+    -   id: check-case-conflict
+    -   id: check-docstring-first
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+#    -   id: check-yaml
+    -   id: debug-statements
+    -   id: fix-byte-order-marker
+    -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: mixed-line-ending
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+    -   id: mypy
+        additional_dependencies:
+            - types-PyYAML
+-   repo: https://github.com/asottile/add-trailing-comma
+    rev: v3.1.0
+    hooks:
+    -   id: add-trailing-comma
+#-   repo: https://github.com/dannysepler/rm_unneeded_f_str
+#    rev: v0.2.0
+#    hooks:
+#    -   id: rm-unneeded-f-str
+-   repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/bandit
+    rev: 1.7.7
+    hooks:
+    -   id: bandit
+        args: ["-x", "tests/*.py"]

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Joshua Sundance Bailey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,78 @@
+---
+title: mtg-coloridentity
+emoji: 🧙
+colorFrom: white
+colorTo: red
+sdk: streamlit
+sdk_version: 1.30.0
+app_file: app.py
+pinned: true
+license: mit
+---
+
+# mtg-coloridentity
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![python](https://img.shields.io/badge/Python-3-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+
+[![Push to HuggingFace Space](https://github.com/joshuasundance-swca/mtg-coloridentity/actions/workflows/hf-space.yml/badge.svg)](https://github.com/joshuasundance-swca/mtg-coloridentity/actions/workflows/hf-space.yml)
+[![Open HuggingFace Space](https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/joshuasundance/mtg-coloridentity)
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+
+
+# mtg-coloridentity
+
+🤖 This README was written by GPT-4. 🤖
+
+## Overview
+This Streamlit app is designed for the multi-label classification of Magic: The Gathering (MTG) cards,
+specifically focusing on their color identity.
+It utilizes a pre-trained model hosted on Hugging Face, `joshuasundance/mtg-coloridentity-multilabel-classification`,
+to predict the color identity of MTG cards based on their names and descriptions.
+
+## Features
+- Interactive UI: Users can input the name and text of any MTG card to get predictions on its color identity.
+- Color Probabilities: The app displays the probability of each color identity (Black, Green, Red, Blue, White) for the given card.
+- Random Card Selection: With a "Roll the Dice" feature, users can load the text of a random MTG card from the dataset.
+
+## How It Works
+The app fetches a pre-trained `SetFit` model from Hugging Face and uses it to
+predict the color identities of MTG cards.
+The model's predictions are displayed as a bar chart,
+showing the probability of each color identity.
+
+## Getting Started
+To run this app locally, clone the repository and ensure you have the following prerequisites installed:
+
+- Python 3.x
+- `streamlit`
+- `pandas`
+- `seaborn`
+- `matplotlib`
+- `datasets` and `setfit` from Hugging Face
+
+## Contributions, Support, and Contact
+
+Contributions to this project are welcome! Please feel free to submit issues and pull requests.
+
+For support, please raise an issue on GitHub or in the HuggingFace space.
+
+## License
+
+This project is under the [MIT License](LICENSE.md).
+
+## Acknowledgments
+
+Thanks to HuggingFace and `setfit`!
+
+## TODO
+- [ ] make a todo list ;)
+- [ ] improve READMEs
+- [ ] make better model(s)
+- [x] learn in public

app.py

@@ -0,0 +1,109 @@
+import os
+import random
+from typing import Sequence
+
+import datasets
+import matplotlib.pyplot as plt
+import pandas as pd
+import seaborn as sns
+import streamlit as st
+from setfit import SetFitModel
+
+st.set_page_config(
+    page_title="mtg-coloridentity-multilabel-classification",
+    page_icon="🧙",
+    layout="wide",
+    initial_sidebar_state="collapsed",
+    menu_items=None,
+)
+
+
+default_hf_home = os.path.join(os.path.expanduser("~"), ".cache", "huggingface")
+HF_HOME = os.environ.get("HF_HOME", default_hf_home)
+
+coloridentity_model = "joshuasundance/mtg-coloridentity-multilabel-classification"
+
+colors = ["B", "G", "R", "U", "W"]
+labels = ["black", "green", "red", "blue", "white"]
+
+sns.set()
+
+col1, col2 = st.columns(2)
+
+
+@st.cache_resource
+def get_model(
+    model_id: str = coloridentity_model,
+    cache_dir: str = HF_HOME,
+    **kwargs,
+) -> SetFitModel:
+    return SetFitModel.from_pretrained(model_id, cache_dir=cache_dir, **kwargs)
+
+
+@st.cache_data
+def get_data(
+    repo_id: str = coloridentity_model,
+    cache_dir: str = HF_HOME,
+    **kwargs,
+) -> datasets.Dataset:
+    dataset_dict = datasets.load_dataset(repo_id, cache_dir=cache_dir, **kwargs)
+    return datasets.concatenate_datasets(
+        list(dataset_dict.values()),
+    )
+
+
+def get_random_text() -> str:
+    return dataset.select([random.randint(0, len(dataset))])[0]["text"]  # nosec
+
+
+@st.cache_data
+def get_preds(input_text: str) -> Sequence[float]:
+    return model.predict_proba(input_text)
+
+
+def prob_bars(preds: Sequence[float]) -> None:
+    _preds = (float(p) for p in preds)
+    df = pd.DataFrame(
+        zip(labels, _preds),
+        columns=["Color", "Probability"],
+    )
+    plt.figure(figsize=(8, 6))
+    ax = sns.barplot(x="Color", y="Probability", data=df, palette=labels)
+
+    # Add data labels on each bar
+    for p in ax.patches:
+        ax.annotate(
+            format(p.get_height(), ".4f"),
+            (p.get_x() + p.get_width() / 2.0, p.get_height()),
+            ha="center",
+            va="center",
+            xytext=(0, 9),
+            textcoords="offset points",
+        )
+
+    plt.title("Prediction Probabilities")
+    plt.xlabel("Color")
+    plt.ylabel("Probability")
+    st.pyplot(plt.gcf())
+
+
+model = get_model()
+dataset = get_data()
+default_text = get_random_text()
+
+if "input_text" not in st.session_state:
+    st.session_state.input_text = default_text
+
+with col1:
+    if st.button("🎲 Roll the Dice"):
+        st.session_state.input_text = get_random_text()
+    input_text = st.text_area(
+        "Card name and text",
+        st.session_state.input_text,
+        height=400,
+    )
+
+preds = get_preds(input_text)
+
+with col2:
+    prob_bars(preds)

requirements.txt

@@ -0,0 +1,6 @@
+datasets
+matplotlib
+pandas
+seaborn
+setfit
+streamlit