Guide notebook for query builder #1057
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation for the pyvespa's query builder relies on unit tests and a notebook, which, while comprehensive in their own ways, lack a holistic, application-based perspective.
It might be quite advantagous to have a dedicated guide on using the query builder that goes over a lot more functionality than the notebook and is based on the sample apps currently deployed.
In this context I wrote a guide on using the query builder that is based on the Cord19 sample app. The guide goes over a lot of the functionality already seen in the unit test cases.
Requesting for feedback on improvements on the guide after which it can potentially be merged.
Also want to understand the best way to showcase the
nearestNeighbor
and other embeddings based functionality (maybe through the search app?) considering the cord19 app lack embedders. Currently the guide needs to be enhanced on those.Tagging @thomasht86 as discussed.