adamelliotfields commited on
Commit
14f6d19
1 Parent(s): bdcb718

Update readme

Browse files
Files changed (1) hide show
  1. README.md +44 -4
README.md CHANGED
@@ -1,13 +1,53 @@
1
  ---
2
- title: Api Inference
3
- emoji: 🏃
 
 
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: streamlit
7
  sdk_version: 1.37.1
 
8
  app_file: app.py
9
- pinned: false
 
 
10
  license: apache-2.0
11
  ---
 
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ # https://huggingface.co/docs/hub/en/spaces-config-reference
3
+ title: API Inference
4
+ short_description: Inference on API endpoints
5
+ emoji: ⚡
6
  colorFrom: blue
7
  colorTo: green
8
  sdk: streamlit
9
  sdk_version: 1.37.1
10
+ python_version: 3.11.9
11
  app_file: app.py
12
+ full_width: true
13
+ pinned: true
14
+ header: mini
15
  license: apache-2.0
16
  ---
17
+ # ⚡ API Inference
18
 
19
+ ## Configuration
20
+
21
+ Streamlit [configuration](https://docs.streamlit.io/develop/concepts/configuration/options) has the following priority order:
22
+ 1. `streamlit run` flags (highest priority)
23
+ 2. environment variables
24
+ 3. local config file
25
+ 4. global config file
26
+
27
+ So you can deploy the local config and override with environment variables as necessary:
28
+
29
+ ```bash
30
+ STREAMLIT_LOGGER_LEVEL=error
31
+ STREAMLIT_CLIENT_SHOW_ERROR_DETAILS=false
32
+ STREAMLIT_CLIENT_TOOLBAR_MODE=viewer
33
+ STREAMLIT_SERVER_FILE_WATCHER_TYPE=none
34
+ STREAMLIT_SERVER_RUN_ON_SAVE=false
35
+ STREAMLIT_BROWSER_SERVER_ADDRESS=adamelliotfields-api-inference.hf.space
36
+ ```
37
+
38
+ ## Installation
39
+
40
+ ```sh
41
+ # clone
42
+ git clone https://huggingface.co/spaces/adamelliotfields/api-inference.git
43
+ cd api-inference
44
+ git remote set-url origin https://adamelliotfields:$HF_TOKEN@huggingface.co/spaces/adamelliotfields/api-inference
45
+
46
+ # install
47
+ python -m venv .venv
48
+ source .venv/bin/activate
49
+ pip install -r requirements.txt
50
+
51
+ # run
52
+ python app.py
53
+ ```