h2oai · 5675sp · Apr 27, 2023 · May 1, 2023 · May 2, 2023 · May 9, 2023
diff --git a/.appignore b/.appignore
@@ -0,0 +1,17 @@
+.DS_Store
+venv/
+.sidekickvenv/
+var/
+.git/
+.idea/
+*/__pycache__/
+scripts/
+setup_cythonize/
+.sh
+build/
+dist/
+tests/
+ci/
+examples/sleep_eda/
+examples/telemetry/
+.log
diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md
@@ -0,0 +1,15 @@
+---
+name: "\U0001F4C3 Documentation"
+about: Create a documentation issue or request to help us improve the sql-sidekick repo
+title: "[DOCS]"
+labels: area/documentation
+assignees: '5675sp'
+---
+
+### 📃 Documentation issue/request
+
+<!-- A clear and concise description of what the documentation issue/request is -->
+
+### Documentation version
+
+<!-- Documentation version (for a current or future version)?  -->
diff --git a/.github/workflows/deploy-to-github-pages.yml b/.github/workflows/deploy-to-github-pages.yml
@@ -0,0 +1,32 @@
+name: Deploy to GitHub pages
+
+on:
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          always-auth: true
+          registry-url: https://npm.pkg.github.com/
+          node-version: 18
+          cache: npm
+          cache-dependency-path: documentation/package-lock.json
+
+      - name: Install dependencies
+        run: cd documentation && npm install --frozen-lockfile
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build docs
+        run: cd documentation && npm run build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./documentation/tmp/build
+          user_name: 5675sp ##swap username out with the username of someone with admin access to the repo
+          user_email: [email protected] ##swap email out with the email of someone with admin access to the repo
diff --git a/.gitignore b/.gitignore
@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "ms-python.python"
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,15 @@
+{
+  "[python]": {
+    "editor.tabSize": 4,
+     "editor.defaultFormatter": "ms-python.black-formatter"
+  },
+    "files.eol": "\n",
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "python.formatting.provider": "none",
+    "python.linting.enabled": true,
+    "python.linting.flake8Enabled": true,
+    "python.formatting.blackArgs": ["--line-length", "120"],
+    "python.linting.flake8Args": ["--max-line-length=120"],
+}
diff --git a/Makefile b/Makefile
@@ -0,0 +1,41 @@
+sentence_transformer = s3cmd get --recursive --skip-existing s3://h2o-model-gym/models/nlp/sentence_trasnsformer/all-MiniLM-L6-v2/ ./models/sentence_transformers/sentence-transformers_all-MiniLM-L6-v2
+demo_data = s3cmd get --recursive --skip-existing s3://h2o-sql-sidekick/demo/sleepEDA/ ./examples/demo/
+
+.PHONY: download_demo_data
+
+all: download_demo_data
+
+setup: download_demo_data ## Setup
+	python3 -m venv .sidekickvenv
+	./.sidekickvenv/bin/python3 -m pip install --upgrade pip
+	./.sidekickvenv/bin/python3 -m pip install wheel
+	./.sidekickvenv/bin/python3 -m pip install -r requirements.txt
+	mkdir -p ./db/sqlite
+	mkdir -p ./examples/demo/
+
+download_models:
+	mkdir -p ./models/sentence_transformers/sentence-transformers_all-MiniLM-L6-v2
+
+download_demo_data:
+	mkdir -p ./examples/demo/
+	$(demo_data)
+
+cloud_bundle:
+	h2o bundle -L debug 2>&1 | tee -a h2o-bundle.log
+
+
+setup-doc:  # Install documentation dependencies
+	cd documentation && npm install
+
+run-doc:  # Run the doc locally
+	cd documentation && npm start
+
+update-documentation-infrastructure:
+	cd documentation && npm update @h2oai/makersaurus
+	cd documentation && npm ls
+
+build-doc-locally:  # Bundles your website into static files for production
+	cd documentation && npm run build
+
+serve-doc-locally:  # Serves the built website locally
+	cd documentation && npm run serve
diff --git a/README.md b/README.md
@@ -1,2 +1,49 @@
 # sql-sidekick
-A simple sql assistant
+A simple SQL assistant (WIP)
+
+
+# Installation
+## Dev
+```
+1. git clone [email protected]:h2oai/sql-sidekick.git
+2. cd sql-sidekick
+3. make setup
+4. source ./.sidekickvenv/bin/activate
+5. python sidekick/prompter.py
+```
+## Usage
+```
+Dialect: postgres
+- docker pull postgres (will pull the latest version)
+- docker run --rm --name pgsql-dev -e POSTGRES_PASSWORD=abc -p 5432:5432 postgres
+
+Default: sqlite
+Step:
+- Download and install .whl --> s3://sql-sidekick/releases/sql_sidekick-0.0.3-py3-none-any.whl
+- python3 -m venv .sidekickvenv
+- source .sidekickvenv/bin/activate
+- python3 -m pip install sql_sidekick-0.0.3-py3-none-any.whl
+```
+## Start
+```
+Welcome to the SQL Sidekick! I am an AI assistant that helps you with SQL
+queries. I can help you with the following:
+
+  1. Configure a local database(for schema validation and syntax checking):
+  `sql-sidekick configure db-setup -t "<local_dir_path_to_>/table_info.jsonl"` (e.g., format --> https://github.com/h2oai/sql-sidekick/blob/main/examples/telemetry/table_info.jsonl)
+
+  2. Ask a question: `sql-sidekick query -q "avg Gpus" -s "<local_dir_path_to_>/samples.csv"` (e.g., format --> https://github.com/h2oai/sql-sidekick/blob/main/examples/telemetry/samples.csv)
+
+  3. Learn contextual query/answer pairs: `sql-sidekick learn add-samples` (optional)
+
+  4. Add context as key/value pairs: `sql-sidekick learn update-context` (optional)
+
+Options:
+  --version  Show the version and exit.
+  --help     Show this message and exit.
+
+Commands:
+  configure  Helps in configuring local database.
+  learn      Helps in learning and building memory.
+  query      Asks question and returns SQL
+```
diff --git a/__init__.py b/__init__.py
diff --git a/about.md b/about.md
@@ -0,0 +1,12 @@
+**App Goal:** Demo-ware web client for SQL-Sidekick
+
+**Target Audience:** Data (Machine Learning) Scientists, Citizen Data Scientists, Data Engineers Managers and Business Analysts
+
+**Actively Being Maintained:** Yes (Demo release: _In active RnD_)
+
+**Last Updated:** September, 2023
+
+**Allows uploading and using new model and data:** Yes
+
+**Detailed Description:**
+An experimental demo to evaluate text-to-SQL capabilities of large language models (LLMs) to enable QnA for tabular data
diff --git a/app.toml b/app.toml
@@ -0,0 +1,23 @@
+[App]
+name = "ai.h2o.wave.sql-sidekick"
+title = "SQL-Sidekick"
+description = "QnA with tabular data using NLQ"
+LongDescription = "about.md"
+Tags = ["DATA_SCIENCE", "MACHINE_LEARNING", "NLP"]
+Version = "0.0.13"
+
+[Runtime]
+MemoryLimit = "64Gi"
+MemoryReservation = "16Gi"
+module = "start"
+VolumeMount = "/meta_data"
+VolumeSize = "100Gi"
+ResourceVolumeSize = "64Gi"
+GPUCount = 1
+RuntimeVersion = "ub2004_cuda114_cudnn8_py38_wlatest_a10g"
+RoutingMode = "BASE_URL"
+EnableOIDC = true
+
+[[Env]]
+Name = "H2O_WAVE_MAX_REQUEST_SIZE"
+Value = "20M"
diff --git a/documentation/.gitignore b/documentation/.gitignore
@@ -0,0 +1,17 @@
+node_modules
+tmp
+
+# Generated files
+.docusaurus
+.cach-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,20 @@
+# New Documentation Site
+
+What is the purpose of these docs?
+
+## Running this site
+
+This site was generated using Makersaurus, which is a very thin wrapper around Facebook's Docusaurus. You can write documentation in the typical way, using markdown files located in the `docs` folder and registering those files in `sidebars.js`. 
+
+Use the following commands to run the generate the site and run it locally:
+
+```
+npx @h2oai/makersaurus@latest gen
+cd gen
+npm install
+npm start
+```
+
+## More information
+
+Use the Makersaurus docs to earn how to edit docs, deploy the site, set up versioning and more.
diff --git a/documentation/docs/admin-guide/page-1.md b/documentation/docs/admin-guide/page-1.md
@@ -0,0 +1 @@
+# Page 1
diff --git a/documentation/docs/api-reference-guide/page-1.md b/documentation/docs/api-reference-guide/page-1.md
@@ -0,0 +1 @@
+# Page 1
diff --git a/documentation/docs/application-name-logo.png b/documentation/docs/application-name-logo.png
diff --git a/documentation/docs/concepts.md b/documentation/docs/concepts.md
@@ -0,0 +1 @@
+# Concepts 
diff --git a/documentation/docs/faqs.md b/documentation/docs/faqs.md
@@ -0,0 +1,13 @@
+# FAQs
+
+[application_description]
+
+
+---
+
+The below sections provide answers to frequently asked questions. If you have additional questions, please send them to <[email protected]>.
+
+
+## General
+
+