Skip to content

Commit

Permalink
slight README.md modification
Browse files Browse the repository at this point in the history
  • Loading branch information
george1459 committed Apr 6, 2024
1 parent faed512 commit 7eb3f10
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 0 additions & 8 deletions docs/install_pip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/.
Expand Down

0 comments on commit 7eb3f10

Please sign in to comment.