alanbarret
commited on
Commit
·
93bb0e1
1
Parent(s):
d30064d
updated readme
Browse files- .gitattributes +36 -1
- README.md +1 -61
.gitattributes
CHANGED
@@ -1,2 +1,37 @@
|
|
1 |
# Auto detect text files and perform LF normalization
|
2 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
# Auto detect text files and perform LF normalization
|
2 |
+
*.7z filter=lfs diff=lfs merge=lfs -text
|
3 |
+
*.arrow filter=lfs diff=lfs merge=lfs -text
|
4 |
+
*.bin filter=lfs diff=lfs merge=lfs -text
|
5 |
+
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
6 |
+
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
7 |
+
*.ftz filter=lfs diff=lfs merge=lfs -text
|
8 |
+
*.gz filter=lfs diff=lfs merge=lfs -text
|
9 |
+
*.h5 filter=lfs diff=lfs merge=lfs -text
|
10 |
+
*.joblib filter=lfs diff=lfs merge=lfs -text
|
11 |
+
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
12 |
+
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
13 |
+
*.model filter=lfs diff=lfs merge=lfs -text
|
14 |
+
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
15 |
+
*.npy filter=lfs diff=lfs merge=lfs -text
|
16 |
+
*.npz filter=lfs diff=lfs merge=lfs -text
|
17 |
+
*.onnx filter=lfs diff=lfs merge=lfs -text
|
18 |
+
*.ot filter=lfs diff=lfs merge=lfs -text
|
19 |
+
*.parquet filter=lfs diff=lfs merge=lfs -text
|
20 |
+
*.pb filter=lfs diff=lfs merge=lfs -text
|
21 |
+
*.pickle filter=lfs diff=lfs merge=lfs -text
|
22 |
+
*.pkl filter=lfs diff=lfs merge=lfs -text
|
23 |
+
*.pt filter=lfs diff=lfs merge=lfs -text
|
24 |
+
*.pth filter=lfs diff=lfs merge=lfs -text
|
25 |
+
*.rar filter=lfs diff=lfs merge=lfs -text
|
26 |
+
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
27 |
+
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
28 |
+
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
29 |
+
*.tar filter=lfs diff=lfs merge=lfs -text
|
30 |
+
*.tflite filter=lfs diff=lfs merge=lfs -text
|
31 |
+
*.tgz filter=lfs diff=lfs merge=lfs -text
|
32 |
+
*.wasm filter=lfs diff=lfs merge=lfs -text
|
33 |
+
*.xz filter=lfs diff=lfs merge=lfs -text
|
34 |
+
*.zip filter=lfs diff=lfs merge=lfs -text
|
35 |
+
*.zst filter=lfs diff=lfs merge=lfs -text
|
36 |
+
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
37 |
+
|
README.md
CHANGED
@@ -10,64 +10,4 @@ pinned: false
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
-
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
14 |
-
|
15 |
-
### Hosted on Streamlit:
|
16 |
-
|
17 |
-
To use ResearchPaper, you can use the hosted version at [ai-research-paper.streamlit.app](https://ai-research-paper.streamlit.app/)
|
18 |
-
|
19 |
-
### Run locally:
|
20 |
-
|
21 |
-
Alternatively, you can run ResearchPaper locally with Streamlit.
|
22 |
-
|
23 |
-
#### Step 1
|
24 |
-
First, set your Groq API key in the environment variables:
|
25 |
-
|
26 |
-
~~~
|
27 |
-
export GROQ_API_KEY="gsk_yA..."
|
28 |
-
~~~
|
29 |
-
|
30 |
-
This is an optional step that allows you to skip setting the Groq API key later in the Streamlit app.
|
31 |
-
|
32 |
-
#### Step 2
|
33 |
-
Next, set up a virtual environment and install the dependencies.
|
34 |
-
|
35 |
-
~~~
|
36 |
-
python3 -m venv venv
|
37 |
-
~~~
|
38 |
-
|
39 |
-
~~~
|
40 |
-
source venv/bin/activate # Bash
|
41 |
-
|
42 |
-
venv\Scripts\activate.bat # Windows
|
43 |
-
~~~
|
44 |
-
|
45 |
-
~~~
|
46 |
-
pip3 install -r requirements.txt
|
47 |
-
~~~
|
48 |
-
|
49 |
-
#### Step 3 (Windows Only)
|
50 |
-
It may be required to install GTK3 for users on Windows.
|
51 |
-
|
52 |
-
~~~
|
53 |
-
https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer?tab=readme-ov-file
|
54 |
-
~~~
|
55 |
-
|
56 |
-
#### Step 4
|
57 |
-
Finally, run the Streamlit app.
|
58 |
-
|
59 |
-
~~~
|
60 |
-
python3 -m streamlit run main.py
|
61 |
-
~~~
|
62 |
-
|
63 |
-
## Details
|
64 |
-
|
65 |
-
### Technologies
|
66 |
-
|
67 |
-
- Streamlit
|
68 |
-
- Llama3 on Groq Cloud
|
69 |
-
|
70 |
-
### Limitations
|
71 |
-
|
72 |
-
ResearchPaper may generate placeholder content or information that requires verification. It is recommended to use ResearchPaper for drafting research papers and then refine the content with verified information.
|
73 |
-
|
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|