willieneis commited on
Commit
3cd10ab
·
1 Parent(s): 73903c2

minor updates in README

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -1,10 +1,10 @@
1
- <p align="center"><img src="./readme_images/banner.png" width=450 /></p>
2
 
3
  **ArXiv Digest and Personalized Recommendations using Large Language Models.**
4
 
5
  This repo aims to provide a better daily digest for newly published arXiv papers based on your own research interests and natural-language descriptions, using relevancy ratings from GPT.
6
 
7
- You can try it out on [Hugging Face](https://huggingface.co/spaces/AutoLLM/ArxivDigest) using your own OpenAI api key.
8
 
9
  You can also create a daily subscription pipeline to email you the results.
10
 
@@ -37,7 +37,7 @@ We provide a demo at [https://huggingface.co/spaces/AutoLLM/ArxivDigest](https:/
37
 
38
  ![hfexample](./readme_images/hf_example.png)
39
 
40
- You can also send yourself an email of the digest by creating a SendGrid account and [api key](https://app.SendGrid.com/settings/api_keys).
41
 
42
  ### Some examples of results:
43
 
@@ -68,12 +68,12 @@ The recommended way to get started using this repository is to:
68
 
69
  1. Fork the repository
70
  2. Modify `config.yaml` and merge the changes into your main branch. If you want a different schedule than Sunday through Thursday at 1:25PM UTC, then also modify the file `.github/workflows/daily_pipeline.yaml`
71
- 3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
72
- 4. Create or fetch your api key for [SendGrid](https://app.SendGrid.com/settings/api_keys). You will need a SendGrid account. The free tier will generally suffice. Make sure to [verify your sender identity](https://docs.sendgrid.com/for-developers/sending-email/sender-identity).
73
  5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
74
  - `OPENAI_API_KEY`
75
  - `SENDGRID_API_KEY`
76
- - `FROM_EMAIL` This value must match the email you used to create the SendGrid Api Key. This is not needed if you have it set in `config.yaml`.
77
  - `TO_EMAIL` Only if you don't have it set in `config.yaml`
78
  6. Manually trigger the action or wait until the scheduled action takes place.
79
 
@@ -86,7 +86,7 @@ An alternative way to get started using this repository is to:
86
 
87
  1. Fork the repository
88
  2. Modify `config.yaml` and merge the changes into your main branch. If you want a different schedule than Sunday through Thursday at 1:25PM UTC, then also modify the file `.github/workflows/daily_pipeline.yaml`
89
- 3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
90
  4. Find your email provider's SMTP settings and set the secret `MAIL_CONNECTION` to that. It should be in the form `smtp://user:password@server:port` or `smtp+starttls://user:password@server:port`. Alternatively, if you are using Gmail, you can set `MAIL_USERNAME` and `MAIL_PASSWORD` instead, using an [application password](https://support.google.com/accounts/answer/185833).
91
  5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
92
  - `OPENAI_API_KEY`
@@ -111,12 +111,12 @@ If you do not wish to fork this repository, and would prefer to clone and run it
111
 
112
  1. Install the requirements in `src/requirements.txt`
113
  2. Modify the configuration file `config.yaml`
114
- 3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
115
- 4. Create or fetch your api key for [SendGrid](https://app.SendGrid.com/settings/api_keys) (optional, if you want the script to email you)
116
  5. Set the following secrets as environment variables:
117
  - `OPENAI_API_KEY`
118
  - `SENDGRID_API_KEY` (only if using SendGrid)
119
- - `FROM_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`. Note that this value must match the email you used to create the SendGrid Api Key.)
120
  - `TO_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`)
121
  6. Run `python action.py`.
122
  7. If you are not using SendGrid, the html of the digest will be written to `digest.html`. You can then use your favorite webbrowser to view it.
 
1
+ <p align="center"><img src="./readme_images/banner.png" width=500 /></p>
2
 
3
  **ArXiv Digest and Personalized Recommendations using Large Language Models.**
4
 
5
  This repo aims to provide a better daily digest for newly published arXiv papers based on your own research interests and natural-language descriptions, using relevancy ratings from GPT.
6
 
7
+ You can try it out on [Hugging Face](https://huggingface.co/spaces/AutoLLM/ArxivDigest) using your own OpenAI API key.
8
 
9
  You can also create a daily subscription pipeline to email you the results.
10
 
 
37
 
38
  ![hfexample](./readme_images/hf_example.png)
39
 
40
+ You can also send yourself an email of the digest by creating a SendGrid account and [API key](https://app.SendGrid.com/settings/api_keys).
41
 
42
  ### Some examples of results:
43
 
 
68
 
69
  1. Fork the repository
70
  2. Modify `config.yaml` and merge the changes into your main branch. If you want a different schedule than Sunday through Thursday at 1:25PM UTC, then also modify the file `.github/workflows/daily_pipeline.yaml`
71
+ 3. Create or fetch your API key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
72
+ 4. Create or fetch your API key for [SendGrid](https://app.SendGrid.com/settings/api_keys). You will need a SendGrid account. The free tier will generally suffice. Make sure to [verify your sender identity](https://docs.sendgrid.com/for-developers/sending-email/sender-identity).
73
  5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
74
  - `OPENAI_API_KEY`
75
  - `SENDGRID_API_KEY`
76
+ - `FROM_EMAIL` This value must match the email you used to create the SendGrid API Key. This is not needed if you have it set in `config.yaml`.
77
  - `TO_EMAIL` Only if you don't have it set in `config.yaml`
78
  6. Manually trigger the action or wait until the scheduled action takes place.
79
 
 
86
 
87
  1. Fork the repository
88
  2. Modify `config.yaml` and merge the changes into your main branch. If you want a different schedule than Sunday through Thursday at 1:25PM UTC, then also modify the file `.github/workflows/daily_pipeline.yaml`
89
+ 3. Create or fetch your API key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
90
  4. Find your email provider's SMTP settings and set the secret `MAIL_CONNECTION` to that. It should be in the form `smtp://user:password@server:port` or `smtp+starttls://user:password@server:port`. Alternatively, if you are using Gmail, you can set `MAIL_USERNAME` and `MAIL_PASSWORD` instead, using an [application password](https://support.google.com/accounts/answer/185833).
91
  5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
92
  - `OPENAI_API_KEY`
 
111
 
112
  1. Install the requirements in `src/requirements.txt`
113
  2. Modify the configuration file `config.yaml`
114
+ 3. Create or fetch your API key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
115
+ 4. Create or fetch your API key for [SendGrid](https://app.SendGrid.com/settings/api_keys) (optional, if you want the script to email you)
116
  5. Set the following secrets as environment variables:
117
  - `OPENAI_API_KEY`
118
  - `SENDGRID_API_KEY` (only if using SendGrid)
119
+ - `FROM_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`. Note that this value must match the email you used to create the SendGrid API Key.)
120
  - `TO_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`)
121
  6. Run `python action.py`.
122
  7. If you are not using SendGrid, the html of the digest will be written to `digest.html`. You can then use your favorite webbrowser to view it.