[DOCS0-2] Fill out missing details in docs and check consistency

[blythed]

Read through structure, give live feedback, suggestions, and push improvements.

• Getting started
• Core API
• Apply API
• Execute API
• Models
• Data integrations
  • MongoDB
  • SQL
• AI Integrations
  • Anthropic
  • Cohere
  • OpenAI
  • Jina
  • Scikit-learn
  • Torch
  • Transformers
  • vLLM
  • LlamaCpp
• Fundamentals
• Production features

For each AI integration:

• How to instantiate
• (How to train)

[fnikolai]

The Oracle tab is wrong. It refers toMSSQL

https://docs.superduperdb.com/docs/docs/reusable_snippets/connect_to_superduperdb

[fnikolai]

The Get useful sample data can be renamed to Fetch Dataset

[fnikolai]

Tabs on Compute features have some spaces at the beginning

[fnikolai]

data integrations seems redundant and misleading.

If we want to keep it, then at least it should be similar to reusable snippets

[fnikolai]

Create Vector-Index seems to have an issue with the tabs

[fnikolai]

The SQL statement on Perform a vector search seems a bit odd.

select = query_table_or_collection.like(item, vector_index=vector_index_name, n=10).limit(10)        

Why do we need limit(10) when we have n=10 ?

[fnikolai]

Connecting Listeners is empty

[fnikolai]

On Postgresql of Connect to SuperDuperDB the user and password should be superduper in order to be in compliance with the credentials of the Docker databases.

[fnikolai]

Change Mongo Connection to:

from superduperdb import superduper

user = 'superduper'
password = 'superduper'
port = 27017
host = 'localhost'
database = 'test_db'

db = superduper(f"mongodb://{user}:{password}@{host}:{port}/{database}")

[fnikolai]

Also explain how do to pre-filtering and post-filtering of the data.

In general, whatever questions have raised on Slack/Issues, should be answered somewhere on the docs.

[fnikolai]

from superduperdb import dtype is shown everywhere on Get Useful Samples but it returns

ImportError: cannot import name 'dtype' from 'superduperdb' (/home/superduper/superduperdb/superduperdb/__init__.py)

replace it with:

from superduperdb.backends.ibis.field_types import dtype

[fnikolai]

curl -O s3://superduperdb-public-demo/images.zip returns curl: (1) Unsupported protocol or curl: (1) Protocol "s3" not supported or disabled in libcurl.

You need to replace it with https://superduperdb-public-demo.s3.amazonaws.com/images.zip

The same for video and audio.

[fnikolai]

On Multimodal Vector Search in Define the embedding model datatype the SQL and Mongo are swapped compared to others.

[fnikolai]

On Multimodal Vector Search the Image chunker is missing and therefore the Listener cannot be used.

[fnikolai]

On Multimodal Vector Search when choose Text chunker the listener blocks forever