Hugging Face config & sync

.github/workflows/check_file_size.yml

@@ -0,0 +1,16 @@
+name: Check file size
+on:               # or directly `on: [push]` to run the action on every push on any branch
+  pull_request:
+    branches: [main]
+
+  # to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    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

.github/workflows/sync_to_hf_hub.yml

@@ -0,0 +1,20 @@
+name: Sync to Hugging Face hub
+on:
+  push:
+    branches: [main]
+
+  # to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Push to hub
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: git push https://pkiage:$HF_TOKEN@huggingface.co/spaces/pkiage/time_series_decomposition_demo main

README.md

@@ -1,5 +1,5 @@
 ---
-title: Tool Time Series Decomposition
+title: Time Series Decomposition
 emoji: 📈
 colorFrom: indigo
 colorTo: blue
@@ -85,6 +85,21 @@ python setup.py install
 streamlit run src/app.py
 ```
 
+## Hugging Face Tips
+
+Initial Setup
+- [When creating the Spaces Configuration Reference](https://huggingface.co/docs/hub/spaces-config-reference) ensure the [Streamlit Space](https://huggingface.co/docs/hub/spaces-sdks-streamlit) version (sdk_version) specified is supported by HF
+
+```shell
+git remote add space https://huggingface.co/spaces/pkiage/time_series_autocorrelation_demo
+
+git push --force space main
+```
+- [When syncing with Hugging Face via Github Actions](https://huggingface.co/docs/hub/spaces-github-actions) the [User Access Token](https://huggingface.co/docs/hub/security-tokens) created on Hugging Face (HF) should have write access
+
+
+## Demo Links
+- Hugging Face Space: https://huggingface.co/spaces/pkiage/time_series_decomposition_demo
+- Streamlit Community Cloud: https://pkiage-tool-time-series-autocorrelation-demo-app-l0umps.streamlit.app/
 
 
-<p><small>Project structure based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>.</small></p>

requirements.txt

@@ -1,9 +1,5 @@
-# local package
--e .
-
-# external requirements
-streamlit==1.9.2
-pandas==1.4.2
-statsmodels==0.13.2
-plotly==5.8.0
-matplotlib==3.5.2
+streamlit
+pandas
+statsmodels
+plotly
+matplotlib