Skip to content

Commit

Permalink
Minimal update to the readme (srbhr#255)
Browse files Browse the repository at this point in the history
Co-authored-by: srbhr <[email protected]>
  • Loading branch information
srbhr and srbhr authored Apr 20, 2024
1 parent 8d38bee commit 3a58ca1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
Binary file added Assets/img/Resume_Matcher_GitHub_Banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[Saurabh](mailto:[email protected]).
[[email protected]](mailto:[email protected]).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Resume Matcher](Assets/img/header_image.png)](https://www.resumematcher.fyi)
[![Resume Matcher](Assets/img/Resume_Matcher_GitHub_Banner.jpg)](https://www.resumematcher.fyi)

<div align="center">

Expand All @@ -18,7 +18,7 @@
<div align="center">

![Stars](https://img.shields.io/github/stars/srbhr/Resume-Matcher?style=flat-square&color=EA1179)
![Apache 2.0](https://img.shields.io/github/license/srbhr/Resume-Matcher?style=flat-square&color=525FE1) ![Issues](https://img.shields.io/github/issues/srbhr/Resume-Matcher?style=flat-square&color=F86F03) ![Forks](https://img.shields.io/github/forks/srbhr/Resume-Matcher?style=flat-square&color=0079FF)
![Apache 2.0](https://img.shields.io/github/license/srbhr/Resume-Matcher?style=flat-square&color=525FE1) ![Issues](https://img.shields.io/github/issues/srbhr/Resume-Matcher?style=flat-square&color=F86F03) ![Forks](https://img.shields.io/github/forks/srbhr/Resume-Matcher?style=flat-square&color=0079FF) ![Python](https://img.shields.io/badge/Python-3.10+-FFD43B?style=flat-square&logo=python&logoColor=blue)

[![Discord](https://custom-icon-badges.demolab.com/badge/Discord-blue?style=flat-square&logo=discord&color=F0FF42&logoColor=293462)](https://discord.gg/t3Y9HEuV34) [![Twitter](https://img.shields.io/badge/@__srbhr__-000000?style=flat-square&logo=x&logoColor=white)](https://twitter.com/_srbhr_)
[![Resume Matcher](https://custom-icon-badges.demolab.com/badge/www.resumematcher.fyi-gold?style=flat-square&logo=globe&logoColor=black)](https://www.resumematcher.fyi)
Expand Down Expand Up @@ -49,7 +49,7 @@ The process is as follows:

3. **Key Terms Extraction**: Beyond keyword extraction, the tool uses textacy to identify the main key terms or themes in the job description. This step helps in understanding the broader context of what the resume is about.

4. **Vector Similarity Using Qdrant**: The tool uses [Qdrant](https://github.com/qdrant/qdrant), a highly efficient vector similarity search tool, to measure how closely your resume matches the job description. The more similar they are, the higher the likelihood that your resume will pass the ATS screening.
4. **Vector Similarity Using FastEmbedd**: The tool uses [FastEmbedd](https://github.com/qdrant/fastembed), a highly efficient embedding system, to measure how closely your resume matches the job description. The more similar they are, the higher the likelihood that your resume will pass the ATS screening.

<br/>

Expand Down Expand Up @@ -197,6 +197,7 @@ To run the full stack web application (frontend client and backend api servers),
4. Enter your ngrok token and run the notebook.
5. Copy the url and open it in your browser.
6. ![img_2.png](img_2.png)

### Cohere and Qdrant

1. Visit [Cohere website registration](https://dashboard.cohere.ai/welcome/register) and create an account.
Expand All @@ -205,19 +206,22 @@ To run the full stack web application (frontend client and backend api servers),
4. Get your api key and cluster url.
5. Go to open dashboard in qdrant and enter your api key **for only the first time**
<img src="Assets/img/quadrant_cloud.png" height="60%" width="60%"/>
6. Now create a yaml file named config.yml in Scripts/Similarity/ folder.
7. The format for the conifg file should be as below:
1. Now create a yaml file named config.yml in Scripts/Similarity/ folder.
2. The format for the conifg file should be as below:
```yaml
cohere:
api_key: cohere_key
qdrant:
api_key: qdrant_api_key
url: qdrant_cluster_url
```
8. Please replace your values without any quotes.
3. Please replace your values without any quotes.

*Note: Please make sure that Qdrant_client's version is higher than v1.1*
*Note: This part needs updating w.r.t to the new FastEmbed changes.*
<br/>
<div align="center">
Expand Down

0 comments on commit 3a58ca1

Please sign in to comment.