mechark commited on
Commit
98be57b
·
1 Parent(s): 0e9a6da

feat: add proper README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -46
README.md CHANGED
@@ -1,47 +1,11 @@
1
 
2
- # Paper-Mate - your personal assistant for exploring arXiv papers
3
-
4
- ### Run Paper Mate
5
-
6
- 1. Clone the repository:
7
-
8
- ```bash
9
- git clone https://github.com/mechark/paper-mate.git
10
- ```
11
-
12
- 2. Open the working directory:
13
-
14
- ```bash
15
- cd paper-mate
16
- ```
17
-
18
- 3. Place the ``vector_store`` directory inside the ``/paper-mate``. Download vector_store <a href="https://drive.google.com/uc?export=download&id=1LhkfxMzpbhNNz0OLPt31nb8NYR0lekGB">here</a>
19
- 4. Make sure Docker Engine is running, then build and start the containers:
20
-
21
- ```bash
22
- docker compose up --build
23
- ```
24
-
25
- You can set the language model you want to use via ``MODEL_NAME`` env variable (see other available variables in ``.env.example``). By default the project uses ``llama3.2:3b`` model.
26
-
27
- 🎉 Once <b>everything is up and running</b>, open http://localhost:8000 to checkout the setup!
28
-
29
- ### Examples
30
- ```
31
- 1.
32
- > What is the NEMO paper all about?
33
- > NEMO proposes a system for extracting organization names from PubMed affiliation strings and normalizing them to a canonical organization name.
34
- The system achieves more than 98% f-score in extracting organization names, and it uses clustering based on local sequence alignment metrics and local learning based on finding connected components for normalization.
35
-
36
- 2.
37
- > Do you know something about Indian system to help indians better understand each other? Because they may speak different languages. Can you name such systems? Mention paper names as well.
38
- > Yes, there are several systems and research papers that focus on helping Indians better understand each other by addressing the language barrier:
39
-
40
- "Anusaaraka: Overcoming the Language Barrier in India" (2001) - This system aims to build multilingual speech-to-speech machine translation systems connecting all Indian languages.
41
-
42
- MuRIL: Multilingual Representations for Indian Languages (2021) - This work focuses on improving multilingual language models to better represent and process Indian languages, which are often underrepresented in current models.
43
-
44
- Exploiting Spectral Augmentation for Code-Switched Spoken Language Identification (2020) - While not specifically focused on machine translation, this paper discusses the importance of spoken language identification systems in a multilingual country like India to identify languages present in an audio sample.
45
-
46
- These systems and research papers aim to address the challenges posed by language diversity in India's education sector and promote inclusivity among Indians who speak different languages.
47
- ```
 
1
 
2
+ ---
3
+ title: Paper-Mate
4
+ emoji: 📚
5
+ colorFrom: purple
6
+ colorTo: blue
7
+ sdk: gradio
8
+ sdk_version: "4.44.0"
9
+ app_file: app.py
10
+ pinned: false
11
+ ---