From 7eb3f100656398f0d621a9b60d141992de4cc65f Mon Sep 17 00:00:00 2001 From: Shicheng Liu Date: Sat, 6 Apr 2024 00:01:01 +0000 Subject: [PATCH] slight README.md modification --- README.md | 2 +- docs/install_pip.md | 8 -------- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 31dc3ac..3a334ab 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ There are two main ways of installing the SUQL library. Ideal for integrating the SUQL compiler in a larger codebase / system. See [install_pip.md](https://github.com/stanford-oval/suql/blob/main/docs/install_pip.md) for details. -## Install from source** +## Install from source Ideal for using this repo to build a SUQL-powered conversational interface to your data out-of-the-box, like the one for https://yelpbot.genie.stanford.edu discussed in the paper. See [docs/install_source.md](https://github.com/stanford-oval/suql/blob/main/docs/install_source.md) for details. diff --git a/docs/install_pip.md b/docs/install_pip.md index 4358378..348c6f6 100644 --- a/docs/install_pip.md +++ b/docs/install_pip.md @@ -14,14 +14,6 @@ pip install suql 2. Install `faiss` by `conda install -c conda-forge faiss-gpu`. We recommend the GPU version for accelerated indexing speed. -# Entry point: - -The main entry point to the SUQL compiler is simply: -```python -from suql import suql_execute -``` -See documentation for its specific usage. Now, let's set up your database and 2 servers to enable SUQL access on your db! - # Installing [PostgreSQL database](https://www.postgresql.org/) 1. Follow the instruction there to install a postgreSQL database. For instance, if you are installing on Ubuntu, then follow section `PostgreSQL Apt Repository` at https://www.postgresql.org/download/linux/ubuntu/.