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

Add onboarding doc to demo Elasticsearch #40

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

a68lin
Copy link

@a68lin a68lin commented Apr 21, 2024

No description provided.

@a68lin a68lin marked this pull request as draft April 21, 2024 05:44
@lintool
Copy link
Member

lintool commented Apr 21, 2024

Looking good! 👍

@a68lin
Copy link
Author

a68lin commented Apr 21, 2024

Hello Professor Lin, I've finished a draft of the onboarding doc. Explanations are added to every step.

There are a few remaining problems to solve:

  1. Will this doc be added to the Pyserini project or somewhere else?
  2. I only have access to a macOS laptop so I cannot test the installation on other systems but I add all installing instructions from the official documentation.
  3. I used a all-MiniLM-L6-v2 pre-trained model as the encoder, do you prefer another model?
  4. I showed a simple searching example using only one query from NFCorpus, do I need to add a comprehensive evaluation using Pyserini's evaluating tools?

@a68lin a68lin marked this pull request as ready for review April 21, 2024 20:41
@lintool
Copy link
Member

lintool commented Apr 21, 2024

hi @a68lin - thanks for sending this along. I'll queue up to take a closer look, but quick reactions:

Re: 1. yup, we'll add to Pyserini docs.
Re: 2. you should have access to the student linux machines?
Re: 3. why not use BGE and contriever so it matches https://github.com/castorini/pyserini/blob/master/docs/conceptual-framework2.md ?
Re: 4. align as much as possible with conceptual-framework2.md?

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