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

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

Closed
Tracked by #1074
fazlulkarimweb opened this issue Nov 17, 2023 · 2 comments
Closed
Tracked by #1074
Assignees

Comments

@fazlulkarimweb
Copy link
Collaborator

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
Copy link
Collaborator

blythed commented Nov 17, 2023

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

@fnikolai
Copy link
Collaborator

fnikolai commented Nov 17, 2023

Getting Started

  • Install SuperDuperDB
  • 10 Minutes to SuperDuperDB
  • Talks & Tutorials
  • Best Practices
  • FAQ

Fundamentals

  • Artifacts
  • Components
  • Encoders
  • Data Layer
  • ...
  • Glossary

Walkthough

  • Connect to Database
    • MongoDB
    • MySQL
    • AWS S3
    • Snowflake
  • Deploy Model
  • Run Inference
  • ...

Use Cases

  • Chatbots
    • OpenAI
    • LLM
  • Content Generation
  • Recommenders
  • Question Answering
    • Voice Memos
    • ...
  • Sentiment Analysis
  • Text Summarization
  • Natural Language Processing
  • Forecasting
  • Classification
  • Regression
  • Community Tutorials List

Reference

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants