Skip to content

Commit 8113b8f

Browse files
added documentation for qdrant and cohere api.
1 parent fe0861d commit 8113b8f

File tree

1 file changed

+53
-36
lines changed

1 file changed

+53
-36
lines changed

README.md

+53-36
Original file line numberDiff line numberDiff line change
@@ -57,65 +57,65 @@ Follow these steps to set up the environment and run the application.
5757

5858
2. Clone the forked repository.
5959

60-
```bash
61-
git clone https://github.com/<YOUR-USERNAME>/Resume-Matcher.git
62-
cd Resume-Matcher
63-
```
60+
```bash
61+
git clone https://github.com/<YOUR-USERNAME>/Resume-Matcher.git
62+
cd Resume-Matcher
63+
```
6464

6565
3. Create a Python Virtual Environment:
6666

67-
- Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
67+
- Using [virtualenv](https://learnpython.com/blog/how-to-use-virtualenv-python/):
6868

69-
_Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
69+
_Note_: Check how to install virtualenv on your system here [link](https://learnpython.com/blog/how-to-use-virtualenv-python/).
7070

71-
```bash
72-
virtualenv env
73-
```
71+
```bash
72+
virtualenv env
73+
```
7474

75-
**OR**
75+
**OR**
7676

77-
- Create a Python Virtual Environment:
77+
- Create a Python Virtual Environment:
7878

79-
```bash
80-
python -m venv env
81-
```
79+
```bash
80+
python -m venv env
81+
```
8282

8383
4. Activate the Virtual Environment.
8484

85-
- On Windows.
85+
- On Windows.
8686

87-
```bash
88-
env\Scripts\activate
89-
```
87+
```bash
88+
env\Scripts\activate
89+
```
9090

91-
- On macOS and Linux.
91+
- On macOS and Linux.
9292

93-
```bash
94-
source env/bin/activate
95-
```
93+
```bash
94+
source env/bin/activate
95+
```
9696

9797
5. Install Dependencies:
9898

99-
```bash
100-
pip install -r requirements.txt
101-
```
99+
```bash
100+
pip install -r requirements.txt
101+
```
102102

103103
6. Prepare Data:
104104

105-
- Resumes: Place your resumes in PDF format in the `Data/Resumes` folder. Remove any existing contents in this folder.
106-
- Job Descriptions: Place your job descriptions in PDF format in the `Data/JobDescription` folder. Remove any existing contents in this folder.
105+
- Resumes: Place your resumes in PDF format in the `Data/Resumes` folder. Remove any existing contents in this folder.
106+
- Job Descriptions: Place your job descriptions in PDF format in the `Data/JobDescription` folder. Remove any existing contents in this folder.
107107

108108
7. Parse Resumes to JSON:
109109

110-
```python
111-
python run_first.py
112-
```
110+
```python
111+
python run_first.py
112+
```
113113

114114
8. Run the Application:
115115

116-
```python
117-
streamlit run streamlit_app.py
118-
```
116+
```python
117+
streamlit run streamlit_app.py
118+
```
119119

120120
**Note**: For local versions, you do not need to run "streamlit_second.py" as it is specifically for deploying to Streamlit servers.
121121

@@ -127,12 +127,29 @@ Follow these steps to set up the environment and run the application.
127127

128128
1. Build the image and start application
129129

130-
```bash
131-
docker-compose up
132-
```
130+
```bash
131+
docker-compose up
132+
```
133133

134134
2. Open `localhost:80` on your browser
135135

136+
### Cohere and Qdrant
137+
138+
1. Visit [Cohere website registration](https://dashboard.cohere.ai/welcome/register) and create an account.
139+
2. Go to API keys and copy your cohere api key.
140+
3. Visit [Qdrant website](https://cloud.qdrant.io/) and create an account.
141+
4. Get your api key and cluster url as well
142+
5. Now create a yaml file named config.yml in Scripts/Similarity/ folder.
143+
6. The format for the conifg file should be as below:
144+
```yaml
145+
cohere:
146+
api_key: cohere_key
147+
qdrant:
148+
api_key: qdrant_api_key
149+
url: qdrant_cluster_url
150+
```
151+
7. Please replace your values without any quotes.
152+
136153
<br/>
137154

138155
<div align="center">

0 commit comments

Comments
 (0)