Skip to content

Commit

Permalink
deprecate demo (#1767)
Browse files Browse the repository at this point in the history
Signed-off-by: Fotis Nikolaidis <[email protected]>
  • Loading branch information
fnikolai authored Feb 9, 2024
1 parent 413b3ab commit 20e4581
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 34 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci_notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ jobs:
key: ${{ matrix.os }}_python-${{ matrix.python-version }}_${{ hashFiles('pyproject.toml', '*/pyproject.toml') }}
#---------------------------------------------------

- name: Install Demo Dependencies
run: python -m pip install .[demo]
- name: Install Dependencies
run: python -m pip install .

- name: Run notebook testing
env:
Expand Down
7 changes: 1 addition & 6 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,4 @@ jobs:
- name: Push Base Docker image
run: |
make build_superduperdb
make push_superduperdb
- name: Push Demo Docker image
run: |
make build_demo
make push_demo
make push_superduperdb
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ SuperDuperDB is **not** a database. Think `db = superduper(db)`: SuperDuperDB tr

## Example use-cases and apps (notebooks)

The demo notebooks below are examples how to make use of different frameworks, model providers, vector databases, retrieval techniques and so on.
The notebooks below are examples how to make use of different frameworks, model providers, vector databases, retrieval techniques and so on.

To learn more about *how* to use SuperDuperDB with your database, please check our [Docs](https://docs.superduperdb.com/) and official [Tutorials](https://docs.superduperdb.com/docs/docs/walkthrough/tutorial_walkthrough).

Expand Down
7 changes: 1 addition & 6 deletions docs/hr/content/docs/get_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ Here are the available categories you can use:
- `quality`: Installs tools for aiding in the development of high-quality code.
- `testing`: Installs tools for testing the SuperDuperDB ecosystem.
- `dev`: Installs all the above categories.
- `demo`: Installs all the common dependencies and the dependencies required for the `examples`.

You can find more details on these categories in the [pyproject.toml](https://github.com/SuperDuperDB/superduperdb/blob/main/pyproject.toml) file.

Expand All @@ -70,17 +69,13 @@ If you prefer using Docker, you can pull a pre-built Docker image from Docker Hu
docker run -p 8888:8888 superduperdb/superduperdb:latest
```

This command installs the base `superduperdb` image. If you want to run the ready-to-use examples, you'll need to download the required dependencies at runtime. Alternatively, we provide a pre-built image with all the dependencies for examples preinstalled:
This command installs the base `superduperdb` image. If you want to run the ready-to-use examples, you'll need to download the required dependencies at runtime.

```bash
docker run -p 8888:8888 superduperdb/demo:latest
```

#### Building the image yourself

For more control, you can build the Docker images yourself using the following commands:

```bash
make build_superduperdb
make build_demo
```
4 changes: 2 additions & 2 deletions docs/hr/content/docs/get_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebar_position: 1

Follow these steps to quickly get started:

1. **Explore the demo**
1. **Explore the Notebooks**

Visit [https://demo.superduperdb.com](https://demo.superduperdb.com) to explore our interactive demo and get a feel for what SuperDuperDB has to offer. For a high-level overview of our framework, visit our website at [https://superduperdb.com](https://superduperdb.com). This provides a bird's-eye view of the capabilities and features SuperDuperDB has to offer. The notebooks
Visit [Colab Notebooks](https://colab.research.google.com/github/SuperDuperDB/superduperdb/blob/main/examples/) to explore our interactive notebooks and get a feel for what SuperDuperDB has to offer. For a high-level overview of our framework, visit our website at [https://superduperdb.com](https://superduperdb.com). This provides a bird's-eye view of the capabilities and features SuperDuperDB has to offer. The notebooks
hosted there, can be executed directly in the environment, but can also be cloned in [their original form in the open source repo](https://github.com/SuperDuperDB/superduperdb/tree/main/examples), and executed locally.
These notebooks are also described on this documentation website in the [use-cases section](/docs/use-cases).

Expand Down
2 changes: 1 addition & 1 deletion docs/hr/content/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For more information about SuperDuperDB and why we believe it is much needed, [r
**To get started:**
This documentation serves as your comprehensive guide to kickstarting your `superduperdb` journey 🚀

Additionally, you can check the use-cases [here in the docs](https://docs.superduperdb.com/docs/category/use-cases) as well as the apps built by the [superduper community](https://github.com/SuperDuperDB/superduper-community-apps) and try all of them with [live on your browser](https://demo.superduperdb.com/)!
Additionally, you can check the use-cases [here in the docs](https://docs.superduperdb.com/docs/category/use-cases) as well as the apps built by the [superduper community](https://github.com/SuperDuperDB/superduper-community-apps) and try all of them with [live on your browser](https://colab.research.google.com/github/SuperDuperDB/superduperdb/blob/main/examples/)!



Expand Down
2 changes: 1 addition & 1 deletion docs/hr/content/docs/setup/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ make testenv_image
>
> The listed dependencies may refer to:
> 1. standalone packages (e.g `tensorflow>=2.15.0`)
> 2. dependency groups listed in `pyproject.toml` (e.g `.[demo,server]`)
> 2. dependency groups listed in `pyproject.toml` (e.g `.[dev]`)

Now add these configurations to your setup by running:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ make testenv_image
>
> The listed dependencies may refer to:
> 1. standalone packages (e.g `tensorflow>=2.15.0`)
> 2. dependency groups listed in `pyproject.toml` (e.g `.[demo,server]`)
> 2. dependency groups listed in `pyproject.toml` (e.g `.[dev]`)

Then start the environment with:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Real life use cases could be vectorizing diverse things like images, texts and s
Before proceeding with this use-case, ensure that you have installed the necessary software requirements:

```bash
!pip install superduperdb[demo]
!pip install superduperdb
```

## Connect to Datastore
Expand Down
2 changes: 1 addition & 1 deletion examples/sandbox-example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
"> \n",
"> The listed dependencies may refer to:\n",
"> 1. standalone packages (e.g `tensorflow>=2.15.0`)\n",
"> 2. dependency groups listed in `pyproject.toml` (e.g `.[demo,server]`)\n",
"> 2. dependency groups listed in `pyproject.toml` (e.g `.[dev]`)\n",
"\n",
"\n",
"Then start the environment with:\n",
Expand Down
12 changes: 0 additions & 12 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -123,18 +123,6 @@ enterprise = [

dev = ["superduperdb[torch,apis,docs,quality,testing,server,enterprise]"]

# Dependencies for supported Notebooks in examples dir.
# Whatever modules are defined in the notebooks, must be also defined here.
demo = [
"ipython",
"openai-clip",
"datasets>=2.14.6",
"soundfile",
"sentence-transformers",
"opencv-python",
"matplotlib",
"librosa",
]

[project.urls]
homepage = "https://www.superduperdb.com/"
Expand Down

0 comments on commit 20e4581

Please sign in to comment.