pragneshbarik commited on
Commit
5dafb15
1 Parent(s): a4b427b

updated readme

Browse files
Files changed (1) hide show
  1. README.md +7 -28
README.md CHANGED
@@ -10,17 +10,16 @@ pinned: false
10
  license: mit
11
  ---
12
 
13
- # Mixtral Playground
14
 
15
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
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 = ...
@@ -29,34 +28,14 @@ Follow these steps to set up the environment:
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
- ```
40
- or
41
- ```
42
- python -m streamlit run app.py
43
- ```
44
-
45
- ## Docker Setup
46
-
47
- If you prefer using Docker, follow these steps:
48
-
49
- 1. Clone the repository.
50
- 2. Create a `.env` file to store API credentials, similar to the Python setup.
51
-
52
  3. Build docker image using
53
 
54
  ```
55
- docker build -t mixtral-playground .
56
  ```
57
 
58
  4. Run the image using
59
 
60
  ```
61
- docker run --env-file .env -p 8501:8501 mixtral-playground
62
  ```
 
10
  license: mit
11
  ---
12
 
13
+ # Mixtral Search Engine
14
 
15
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
16
 
17
+ ## Docker Setup
18
 
19
+ If you prefer using Docker, follow these steps:
20
 
21
+ 1. Clone the repository.
22
+ 2. Create a `.env` file to store API credentials.
 
23
 
24
  ```
25
  HF_TOKEN = ...
 
28
  BING_SEARCH_API_KEY = ...
29
  ```
30
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  3. Build docker image using
32
 
33
  ```
34
+ docker build -t mixtral-search .
35
  ```
36
 
37
  4. Run the image using
38
 
39
  ```
40
+ docker run --env-file .env -p 8501:8501 mixtral-search
41
  ```