Spaces:
Sleeping
Sleeping
Juho Inkinen
commited on
Update README with deployment and workshop details
Browse files- .github/README.md +11 -1
.github/README.md
CHANGED
|
@@ -1,16 +1,26 @@
|
|
| 1 |
-
# Annif-
|
| 2 |
|
| 3 |
Developed using Copilot Agent.
|
| 4 |
|
|
|
|
|
|
|
|
|
|
| 5 |
Deploy as a Hugging Face Space by just pushing the code to the HF; you can e.g. add HF as a new remote:
|
| 6 |
|
| 7 |
git remote add huggingface git@hf.co:spaces/NatLibFi/Annif-VLM-demo
|
| 8 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
The app needs these environment variables:
|
| 10 |
- `ANNIF_API_BASE_URL`
|
| 11 |
- `VLM_API_KEY`
|
| 12 |
- `VLM_API_BASE_URL`
|
| 13 |
|
|
|
|
|
|
|
|
|
|
| 14 |
When developing you can use autoreload by running the app like this:
|
| 15 |
|
| 16 |
gradio app.py
|
|
|
|
| 1 |
+
# Annif-VLM-demo
|
| 2 |
|
| 3 |
Developed using Copilot Agent.
|
| 4 |
|
| 5 |
+
This demo is made for a [workshop at Kirjastoverkkopäivät 2025](https://www.kansalliskirjasto.fi/fi/kirjastoverkkopaivat-2025-torstain-tyopajat#tp2-automaattinen-kuvatekstien-tuottaminen-ja-sisallonkuvailu).
|
| 6 |
+
|
| 7 |
+
## Deploment
|
| 8 |
Deploy as a Hugging Face Space by just pushing the code to the HF; you can e.g. add HF as a new remote:
|
| 9 |
|
| 10 |
git remote add huggingface git@hf.co:spaces/NatLibFi/Annif-VLM-demo
|
| 11 |
|
| 12 |
+
and then
|
| 13 |
+
|
| 14 |
+
git push huggingface
|
| 15 |
+
|
| 16 |
The app needs these environment variables:
|
| 17 |
- `ANNIF_API_BASE_URL`
|
| 18 |
- `VLM_API_KEY`
|
| 19 |
- `VLM_API_BASE_URL`
|
| 20 |
|
| 21 |
+
For Hugging Face Space deployment they can be set in [repo settings](https://huggingface.co/docs/hub/spaces-overview#managing-secrets).
|
| 22 |
+
|
| 23 |
+
## Development
|
| 24 |
When developing you can use autoreload by running the app like this:
|
| 25 |
|
| 26 |
gradio app.py
|