superduper-io / superduper

Superduper: Bring AI to your database! Integrate AI models and machine learning workflows with your database to implement custom AI applications, without moving your data. Including streaming inference, scalable model hosting, training and vector search.
https://superduper.io
Apache License 2.0
4.62k stars 449 forks source link

[DOC]: Updating all the notebooks in the use cases section of the documentation #1329

Closed fazlulkarimweb closed 9 months ago

fazlulkarimweb commented 9 months ago

What's wrong?

The notebook section should also be organized effectively. The notebooks primarily cater to three distinct audiences:

  1. Non-tech people like CEOs, Investors, and Founders
  2. Semi-skilled tech people
  3. Highly skilled tech people

Presently, the use case notebooks predominantly focus on highly skilled subject-matter experts. The other two audiences are currently being overlooked.

How could it be better?

For involving the first two groups of audiences, what could be done is:

  1. Non-tech people like CEOs, Investors, and Founders: In the upper section of the notebooks, there should be an explanation of how this piece of code or notebook code can serve as inspiration in real-life use cases.

  2. Semi-skilled tech people: Comment extensively on every line of code so that, when they look into a block, they will understand the code just by reading comments.

blythed commented 9 months ago

TODO: add inline comments, etc., to improve developer experience.

fnikolai commented 9 months ago

Getting Started

Fundamentals

Walkthough

Use Cases

Reference

Sources: https://docs.dask.org/en/stable/api.html https://docs.mindsdb.com/what-is-mindsdb https://milvus.io/docs/manage_databases.md