Push

.dockerignore

@@ -0,0 +1,10 @@
+# Python
+**/__pycache__
+**/*.pyc
+**/*.pyo
+**/*.pyd
+# Ignore unit tests.
+**/*_test.py
+
+# Mac OS.
+.DS_Store

.env

@@ -0,0 +1,40 @@
+# To overwrite these variables, create a .env.local file
+
+# The path to the directory where the data will be downloaded on machine
+LILAC_DATA_PATH=./data
+
+# Set to 1 for duckdb to use views instead of materialized tables (lower memory usage, but slower).
+DUCKDB_USE_VIEWS=0
+
+# Set to true to enable read-only mode, disabling the ability to add datasets & compute dataset
+# signals.
+# LILAC_AUTH_ENABLED=true
+
+# Variables that can be set in .env.local
+#
+# Get key from https://dashboard.cohere.ai/api-keys
+# COHERE_API_KEY=
+
+# GCS_REGION=
+# GCS_ACCESS_KEY=
+# GCS_SECRET_KEY=
+
+# Get key from https://platform.openai.com/account/api-keys
+# OPENAI_API_KEY=
+# Get key from https://makersuite.google.com/app/apikey
+# PALM_API_KEY=
+
+# HuggingFace demos: machine that uploads to HuggingFace.
+
+# For authenticating with HuggingFace to deploy to a Space.
+# HF_USERNAME=
+# The default repo to deploy to for a staging demo. Can be overridden by a command line flag.
+# HF_STAGING_DEMO_REPO='HF_ORG/HF_REPO_NAME'
+
+# For Google-login. This is generated from the Google Cloud Console for a web client.
+# See: https://developers.google.com/identity/protocols/oauth2
+GOOGLE_CLIENT_ID='279475920249-i8llm8vbos1vj5m1qocir8narb3r0enu.apps.googleusercontent.com'
+# The client secret of the above client.
+# GOOGLE_CLIENT_SECRET=
+# A random string for oauth sessions.
+# LILAC_OAUTH_SECRET_KEY=

.env.demo

@@ -0,0 +1,4 @@
+LILAC_DATA_PATH='/data'
+HF_HOME=/data/.huggingface
+TRANSFORMERS_CACHE=/data/.cache
+XDG_CACHE_HOME=/data/.cache

.gitattributes

@@ -1,3 +0,0 @@
-dist/lilac-0.0.13-py3-none-any.whl filter=lfs diff=lfs merge=lfs -text
-data/.cache/lilac/concept/lilac/profanity/gte-small.pkl filter=lfs diff=lfs merge=lfs -text
-data/.cache/lilac/concept/lilac/toxicity/gte-small.pkl filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+**/*.pyc
+**/*.pyo
+**/*.pyd
+**/*_test.py

Dockerfile

@@ -0,0 +1,39 @@
+# NOTE: When we upgrade to 3.11 we can use a slimmer docker image which comes with gcc.
+FROM python:3.9-bullseye
+
+# Allow statements and log messages to immediately appear in the Knative logs
+ENV PYTHONUNBUFFERED True
+
+# See: https://huggingface.co/docs/hub/spaces-sdks-docker#permissions
+RUN useradd -m -u 1000 user
+USER user
+ENV HOME=/home/user \
+	PATH=/home/user/.local/bin:$PATH
+
+# Set the working directory in the container.
+WORKDIR $HOME/app
+
+# Install the dependencies. This requires exporting requirements.txt from poetry first, which
+# happens from ./build_docker.sh.
+COPY --chown=user /dist ./dist/
+RUN pip install --no-index --find-links=dist lilac
+
+#COPY --chown=user requirements.txt .
+#RUN pip install --no-cache-dir -r requirements.txt
+
+COPY --chown=user .env .
+COPY --chown=user .env.demo .
+# Copy the README so we can read the datasets from the HuggingFace config.
+COPY --chown=user README.md .
+COPY --chown=user LICENSE .
+
+# Copy python files.
+#COPY --chown=user /lilac ./lilac/
+
+COPY --chown=user docker_start.sh docker_start.py ./
+
+# Make a local data directory for non-persistent storage demos.
+RUN mkdir -p ./data
+RUN chown -R user ./data
+
+CMD ["bash", "docker_start.sh"]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Lilac AI Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,10 @@
+---
+app_port: 5432
+colorFrom: purple
+colorTo: purple
+datasets: []
+emoji: "\U0001F337"
+sdk: docker
+title: Lilac
+
+---

data/.cache/lilac/concept/lilac/profanity/gte-small.pkl

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:ed7340614b1dea910ddeb26bbda0167b1f4fe2479071a62a70b63c18bc6232d0
-size 1672960

data/.cache/lilac/concept/lilac/toxicity/gte-small.pkl

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:f2af2736f3d749391a431f9c24d3fc78cf8e58457cc4f0d1ce770185b92d879c
-size 1886446

dist/lilac-0.0.13-py3-none-any.whl

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:54b11ac42070eb7829d429b070238a2f1f3a4f3adedbfe40d9f9119b570e8311
-size 1119815

docker_start.py

@@ -0,0 +1,107 @@
+"""Startup work before running the web server."""
+
+import os
+import shutil
+from typing import TypedDict
+
+import yaml
+from huggingface_hub import scan_cache_dir, snapshot_download
+
+from lilac.concepts.db_concept import CONCEPTS_DIR, DiskConceptDB, get_concept_output_dir
+from lilac.env import data_path, env
+from lilac.utils import get_datasets_dir, get_lilac_cache_dir, log
+
+
+def delete_old_files() -> None:
+  """Delete old files from the cache."""
+  # Scan cache
+  try:
+    scan = scan_cache_dir()
+  except BaseException:
+    # Cache was not found.
+    return
+
+  # Select revisions to delete
+  to_delete = []
+  for repo in scan.repos:
+    latest_revision = max(repo.revisions, key=lambda x: x.last_modified)
+    to_delete.extend(
+      [revision.commit_hash for revision in repo.revisions if revision != latest_revision])
+  strategy = scan.delete_revisions(*to_delete)
+
+  # Delete them
+  log(f'Will delete {len(to_delete)} old revisions and save {strategy.expected_freed_size_str}')
+  strategy.execute()
+
+
+class HfSpaceConfig(TypedDict):
+  """The huggingface space config, defined in README.md.
+
+  See:
+  https://huggingface.co/docs/hub/spaces-config-reference
+  """
+  title: str
+  datasets: list[str]
+
+
+def main() -> None:
+  """Download dataset files from the HF space that was uploaded before building the image."""
+  # SPACE_ID is the HuggingFace Space ID environment variable that is automatically set by HF.
+  repo_id = env('SPACE_ID', None)
+  if not repo_id:
+    return
+
+  delete_old_files()
+
+  with open(os.path.abspath('README.md')) as f:
+    # Strip the '---' for the huggingface readme config.
+    readme = f.read().strip().strip('---')
+    hf_config: HfSpaceConfig = yaml.safe_load(readme)
+
+  # Download the huggingface space data. This includes code and datasets, so we move the datasets
+  # alone to the data directory.
+  for lilac_hf_dataset in hf_config['datasets']:
+    print('Downloading dataset from HuggingFace: ', lilac_hf_dataset)
+    snapshot_download(
+      repo_id=lilac_hf_dataset,
+      repo_type='dataset',
+      token=env('HF_ACCESS_TOKEN'),
+      local_dir=get_datasets_dir(data_path()),
+      ignore_patterns=['.gitattributes', 'README.md'])
+
+  snapshot_dir = snapshot_download(repo_id=repo_id, repo_type='space', token=env('HF_ACCESS_TOKEN'))
+  # Copy datasets.
+  spaces_data_dir = os.path.join(snapshot_dir, 'data')
+
+  # Delete cache files from persistent storage.
+  cache_dir = get_lilac_cache_dir(data_path())
+  if os.path.exists(cache_dir):
+    shutil.rmtree(cache_dir)
+
+  # NOTE: This is temporary during the move of concepts into the pip package. Once all the demos
+  # have been updated, this block can be deleted.
+  old_lilac_concepts_data_dir = os.path.join(data_path(), CONCEPTS_DIR, 'lilac')
+  if os.path.exists(old_lilac_concepts_data_dir):
+    shutil.rmtree(old_lilac_concepts_data_dir)
+
+  # Copy cache files from the space if they exist.
+  spaces_cache_dir = get_lilac_cache_dir(spaces_data_dir)
+  if os.path.exists(spaces_cache_dir):
+    shutil.copytree(spaces_cache_dir, cache_dir)
+
+  # Copy concepts.
+  concepts = DiskConceptDB(spaces_data_dir).list()
+  for concept in concepts:
+    # Ignore lilac concepts, they're already part of the source code.
+    if concept.namespace == 'lilac':
+      continue
+    spaces_concept_output_dir = get_concept_output_dir(spaces_data_dir, concept.namespace,
+                                                       concept.name)
+    persistent_output_dir = get_concept_output_dir(data_path(), concept.namespace, concept.name)
+    shutil.rmtree(persistent_output_dir, ignore_errors=True)
+    shutil.copytree(spaces_concept_output_dir, persistent_output_dir, dirs_exist_ok=True)
+    shutil.rmtree(spaces_concept_output_dir, ignore_errors=True)
+
+
+if __name__ == '__main__':
+  main()

docker_start.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Fail if any of the commands below fail.
+set -e
+
+python docker_start.py
+gunicorn lilac.server:app \
+  --bind 0.0.0.0:5432 \
+  --preload -k uvicorn.workers.UvicornWorker \
+  --timeout 120