Merge pull request #1 from kkacsh321/fixes_and_docs

Docs on HF Token, gitignore, etc

.gitignore

@@ -0,0 +1,7 @@
+.env
+.streamlit/*
+*/.DS_Store
+*/*/.DS_Store
+.DS_Store
+./models
+models/*

README.md

@@ -155,6 +155,23 @@ with just plain streamlit
 streamlit run RoboTF_LLM_Token_Estimator.py
 ```
 
+## Environment Variables
+
+If you need to access private Huggingface repos you will need to set the environment variable of `HF_TOKEN` to your huggingface api key.
+
+This can be done locally by doing:
+
+```bash
+export HF_TOKEN=<insert token>
+```
+
+In the docker compose file by replacing the `HF_TOKEN` variable
+
+Using docker by passing it at the docker run statement
+
+```bash
+docker run -e HF_TOKEN=<insert token> -p 8505:8505 robotf/robotf-llm-token-estimator
+```
 
 ## Contact
 

Taskfile.yml

@@ -1,7 +1,7 @@
 version: "3"
 
 vars:
-  IMAGE_VERSION: "v0.0.1"
+  IMAGE_VERSION: "v0.0.2"
   IMAGE_NAME: "robotf/robotf-llm-token-estimator"
 
 tasks:

docker-compose.yaml

@@ -13,5 +13,7 @@ services:
         "--server.port",
         "8505",
       ]
+    environment:
+      - HF_TOKEN=<huggingface token>
     ports:
       - 8505:8505

package.json

@@ -1,4 +1,4 @@
 {
     "name": "robotf-llm-token-estimator",
-    "version": "v0.0.1"
+    "version": "v0.0.2"
 }