Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update instructions for retrieval #295

Merged
merged 2 commits into from
Aug 28, 2023

Conversation

neubig
Copy link
Collaborator

@neubig neubig commented Aug 28, 2023

Description

This PR updates the dataset retrieval section of the notebook demo to remove all places where the CLI was used for input. Now all of the design decisions can be modified by changing variables in the jupyter notebook.

References

Blocked by

  • NA

@zhaochenyang20
Copy link
Collaborator

I have a suggestion for this line:

Set your OpenAI API key as an environment variable. A good way to do this is to create a `.env` file with a single line

OPENAI_API_KEY=<your key here>

and then run the following command.

Add this:

and then run the following command to load environment variables from your `.env` file into the running script.

Sorry I do not add this suggestion in previous PR review.

@zhaochenyang20
Copy link
Collaborator

"In this demo, we will use the following prompt to specify a **question answering system**. If you want to try prompt2model on a new task, you can write a similar prompt by swapping in a new description and new examples. Note that this format is a bit flexible, so you don't have to follow this *exact* format, but it is a good starting point."

Here is my suggestion:

"In this demo, we will use the following prompt to specify a **question answering system**. If you want to try prompt2model on a new task, you can write a similar prompt by swapping in a new description and new examples. Note that this format is a bit flexible, so you don't have to follow this *exact* format, but it is a good starting point. We also have some suggestions for [writing good prompts](./prompt_examples.md)"

Copy link
Collaborator

@zhaochenyang20 zhaochenyang20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing code!!!

@neubig neubig merged commit 86a682c into add_colab_demo Aug 28, 2023
@neubig neubig deleted the update_retrieval_instructions branch August 28, 2023 12:30
neubig added a commit that referenced this pull request Aug 29, 2023
* add demo.ipynb

* add avatar

* new readme

* new readme

* new link

* Revisions to the colab demo (#293)

* Update instructions for retrieval (#295)

* add instruction to create .env

* fix event loop already running in asyncio

* Add process dataset list (#298)

* add process_generated_and_retrieved_datasets

* change parameters

* change notebook

* add variable names

* lint

---------

Co-authored-by: zhaochen20 <[email protected]>

* Fix some wording and asyncio (#297)

* Fix some wording and asyncio

* Update notebook_demo.ipynb

Co-authored-by: Eren Chenyang Zhao <[email protected]>

---------

Co-authored-by: Eren Chenyang Zhao <[email protected]>

* Add wrap input (#300)

* add wrap_input

* add wrap_input

* Update notebook_demo.ipynb

Co-authored-by: Graham Neubig <[email protected]>

---------

Co-authored-by: zhaochen20 <[email protected]>
Co-authored-by: Graham Neubig <[email protected]>

* Wording modifications to notebook demo (#299)

* Made some modifications to wording

* Revert batch size

* Small modifications

* Rename demo files to prompt2model_demo (#307)

* Make a directory for the dataset retriever

* Squash a few bugs

* Mention A100 GPUs

* Increase executor batch size

* Fix typo

* Fix bug in try it out

* Update prompt2model_demo.ipynb

* Update tests/dataset_processor_test.py

Co-authored-by: Vijay Viswanathan <[email protected]>

---------

Co-authored-by: zhaochen20 <[email protected]>
Co-authored-by: Graham Neubig <[email protected]>
Co-authored-by: Vijay Viswanathan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants