Updated README.md
This commit is contained in:
parent
4813904fc7
commit
af4a0f8fe8
24
README.md
24
README.md
|
@ -2,6 +2,24 @@
|
|||
|
||||
A Go CLI tool for fetching, processing, and analyzing academic papers from arXiv using LLM-based evaluation.
|
||||
|
||||
The primary target here was to do somethiung more flexible than keyword search. There are so many papers published I don't have time to read them all, so I ask an LLM to help. I provide a file - the criteria file - with a natural-language description of what I care about and then it filters the abstracts against that criteria.
|
||||
|
||||
Example criteria:
|
||||
```criteria.md
|
||||
Accepted papers MUST:
|
||||
|
||||
* primarily address LLMs (Large Language Models)
|
||||
|
||||
Accepted paper MUST NOT:
|
||||
|
||||
* primarily address legal, social, or ethical subjects
|
||||
* primarily address medical applications
|
||||
|
||||
REJECT explanations can be very brief, less than 30 tokens.
|
||||
```
|
||||
|
||||
This is hard to pull off with keyword searches. You might exclude every paper that includes the word "ethical" only to find out that several papers include it in their notes or limitations section but it has nothing to do with the paper itself.
|
||||
|
||||
## Features
|
||||
|
||||
- Fetch papers from arXiv API based on date range and search query
|
||||
|
@ -36,7 +54,7 @@ papers -search-only -start 20240101 -end 20240131 -query "machine learning"
|
|||
|
||||
Use input file:
|
||||
```bash
|
||||
papers -input papers.json -api-key "your-key"
|
||||
papers -input papers.json -api-key "your-key" -criteria criteria.md
|
||||
```
|
||||
|
||||
### Required Flags
|
||||
|
@ -56,6 +74,8 @@ papers -input papers.json -api-key "your-key"
|
|||
- `-json-output`: Custom JSON output file path (default: YYYYMMDD-YYYYMMDD-query.json)
|
||||
- `-md-output`: Custom Markdown output file path (default: YYYYMMDD-YYYYMMDD-query.md)
|
||||
|
||||
**NB: default API endpoint is LMStudio, and Phi-4 does a great job filtering papers**
|
||||
|
||||
## Pipeline
|
||||
|
||||
1. **Fetch**: Retrieves papers from arXiv based on specified date range and query
|
||||
|
@ -92,4 +112,4 @@ The tool includes various error checks:
|
|||
|
||||
## License
|
||||
|
||||
[License information not provided in source]
|
||||
* MIT license
|
||||
|
|
Loading…
Reference in New Issue