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

feature request: add a sample db for the documentation #109

Open
aborruso opened this issue Dec 16, 2024 · 2 comments
Open

feature request: add a sample db for the documentation #109

aborruso opened this issue Dec 16, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@aborruso
Copy link
Contributor

Hi,
in the documentation we have this kind of examples

SELECT llm_complete(
    {'model_name': 'description-model'},
    {'prompt': 'Generate a description for the next product based on its product name.'},
    {'product_name': product_name}
) AS product_description  
FROM products;  

But we do not have a sample db that contains products table. I know, it is easy to create, but I would make a db available, to best and quickly replicate what is written in the documentation.

Thank you

@queryproc queryproc added the enhancement New feature or request label Dec 17, 2024
@queryproc
Copy link
Member

Perhaps it makes sense to distinguish between tutorials and documentation? A tutorial is where we would provide such a database. We are currently thinking of how to improve the documentation and anyone's experience getting started so this comment is very much appreciated.

We started preparing some notebooks here to use for tutorials: https://github.com/dsg-polymtl/flockmtl/tree/main/notebooks

I will leave this open. Hopefully you give us some feedback on the notebooks (be careful of missing LIMIT and running anything at scale from there). After your feedback, we can decide how to proceed.

Thank you!

@aborruso
Copy link
Contributor Author

Thank you @queryproc I will give you feedback as soon as I can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants