Spaces:
Running
Running
Commit
•
b89ec8f
1
Parent(s):
aa1bd47
updated readme
Browse files
README.md
CHANGED
@@ -9,18 +9,19 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
|
|
12 |
|
13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
14 |
|
15 |
|
16 |
-
|
17 |
|
18 |
-
|
19 |
-
2. Create and activate a new virtual environment, using either `conda` or `venv`
|
20 |
|
21 |
-
|
|
|
|
|
22 |
|
23 |
-
3. Make a .env file, for storing api credentials, currently using these 4 credentials.
|
24 |
```
|
25 |
HF_TOKEN = ...
|
26 |
GOOGLE_SEARCH_ENGINE_ID = ...
|
@@ -28,11 +29,11 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
|
|
28 |
BING_SEARCH_API_KEY = ...
|
29 |
```
|
30 |
|
31 |
-
4. Install requirements
|
32 |
```
|
33 |
pip install -r requirements.txt --user
|
34 |
```
|
35 |
-
5.
|
36 |
```
|
37 |
streamlit run app.py
|
38 |
```
|
@@ -41,3 +42,21 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
|
|
41 |
python -m streamlit run app.py
|
42 |
```
|
43 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
12 |
+
# Mixtral Playground
|
13 |
|
14 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
15 |
|
16 |
|
17 |
+
## Python Setup
|
18 |
|
19 |
+
Follow these steps to set up the environment:
|
|
|
20 |
|
21 |
+
1. Clone this repository.
|
22 |
+
2. Create and activate a new virtual environment using `conda` or `venv`. If you need guidance, refer to this [tutorial](https://www.perplexity.ai/search/how-to-make-GnFc09yGTvSyka0ZWqhSQg?s=c).
|
23 |
+
3. Create a `.env` file to store API credentials. You'll need these four credentials:
|
24 |
|
|
|
25 |
```
|
26 |
HF_TOKEN = ...
|
27 |
GOOGLE_SEARCH_ENGINE_ID = ...
|
|
|
29 |
BING_SEARCH_API_KEY = ...
|
30 |
```
|
31 |
|
32 |
+
4. Install the necessary requirements:
|
33 |
```
|
34 |
pip install -r requirements.txt --user
|
35 |
```
|
36 |
+
5. Start the Streamlit server using either command:
|
37 |
```
|
38 |
streamlit run app.py
|
39 |
```
|
|
|
42 |
python -m streamlit run app.py
|
43 |
```
|
44 |
|
45 |
+
|
46 |
+
## Docker Setup
|
47 |
+
|
48 |
+
If you prefer using Docker, follow these steps:
|
49 |
+
|
50 |
+
1. Clone the repository.
|
51 |
+
2. Create a `.env` file to store API credentials, similar to the Python setup.
|
52 |
+
|
53 |
+
3. Build docker image using
|
54 |
+
|
55 |
+
```
|
56 |
+
docker build -t mixtral-playground .
|
57 |
+
```
|
58 |
+
4. Run the image using
|
59 |
+
|
60 |
+
```
|
61 |
+
docker run --env-file .env -p 8501:8501 mixtral-playground
|
62 |
+
```
|