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

Explain the example notebook options better #11

Open
dgarijo opened this issue Sep 23, 2020 · 0 comments
Open

Explain the example notebook options better #11

dgarijo opened this issue Sep 23, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dgarijo
Copy link
Contributor

dgarijo commented Sep 23, 2020

Right now you can describe or search. But here are a few things that need to be clarified:

  • The URIs are not clickable, and that is fine. They are ids that right now don't resolve, but it should be clarified or users will be confused.
  • The notebook asks for the method of search. It should clarify (probably in the instructions before the notebook) what does this mean, and provide an example. Then sosen asks for a query, which may be seen as free text. An example would help too.
  • The describe mechanic does not always return a table.
  • I think the tf-idf score should be better explained before the notebook.
@dgarijo dgarijo added the documentation Improvements or additions to documentation label Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant