diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1238f019..afeb5235 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,6 +15,9 @@ sphinx: formats: - pdf +conda: + file: environment.yml + # Optionally declare the Python requirements required to build your docs python: install: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a08df16..9ee022b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ To set up for development, create a conda environment, install lotus, and install additional dev dependencies. ``` -conda create -n lotus python=3.10 -y +conda env create -f environment.yml conda activate lotus git clone git@github.com:stanford-futuredata/lotus.git pip install -e . diff --git a/README.md b/README.md index 89e4b30c..16a862f2 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ LOTUS offers a number of semantic operators in a Pandas-like API, some of which # Installation ``` -conda create -n lotus python=3.10 -y +conda env create -f environment.yml conda activate lotus pip install lotus-ai ``` diff --git a/docs/installation.rst b/docs/installation.rst index 017d365a..47cb6d16 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -16,6 +16,6 @@ You can install Lotus using pip: .. code-block:: console - $ conda create -n lotus python=3.10 -y + $ conda env create -f environment.yml $ conda activate lotus $ pip install lotus-ai \ No newline at end of file diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 404a5c89..af60d0b6 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -2,7 +2,6 @@ sphinx==7.3.7 sphinx-rtd-theme==2.0.0 backoff==2.2.1 -faiss-cpu==1.8.0.post1 litellm==1.51.0 numpy==1.26.4 pandas==2.2.2 diff --git a/environment.yml b/environment.yml new file mode 100644 index 00000000..f40a9f33 --- /dev/null +++ b/environment.yml @@ -0,0 +1,7 @@ +name: lotus +channels: + - conda-forge + - pytorch +dependencies: + - python=3.10 + - faiss-cpu=1.8.0 diff --git a/pyproject.toml b/pyproject.toml index 6a170ce0..7156ba68 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,7 +23,6 @@ classifiers = [ dependencies = [ "backoff>=2.2.1,<3.0.0", - "faiss-cpu>=1.8.0.post1,<2.0.0", "litellm>=1.51.0,<2.0.0", "numpy>=1.25.0,<2.0.0", "pandas>=2.0.0,<3.0.0", diff --git a/requirements.txt b/requirements.txt index 655dde54..59945430 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ backoff==2.2.1 -faiss-cpu==1.8.0.post1 litellm==1.51.0 numpy==1.26.4 pandas==2.2.2