Skip to content

Commit 0200df4

Browse files
committed
pip package
1 parent 24482e4 commit 0200df4

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
/*__pycache__/
2+
dist/
3+
src/tree_of_thoughts_llm.egg-info/
24
.env
35
*.pyc
46
*.DS_Store

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,14 @@ Also check [its tweet thread](https://twitter.com/ShunyuYao12/status/16593575474
2020

2121

2222
## Setup
23-
- Set up OpenAI API key and store in environment variable ``OPENAI_API_KEY`` (see [here](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)).
23+
1. Set up OpenAI API key and store in environment variable ``OPENAI_API_KEY`` (see [here](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)).
2424

25-
- Install dependencies and `tot` package (PyPI package coming soon):
25+
2. Install `tot` package in two ways:
26+
- Option 1: Install from PyPI
27+
```bash
28+
pip install tree-of-thought-llm
29+
```
30+
- Option 2: Install from source
2631
```bash
2732
git clone https://github.com/princeton-nlp/tree-of-thought-llm
2833
cd tree-of-thought-llm

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools >= 61.0.0"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "tot"
6+
name = "tree-of-thoughts-llm"
77
version = "0.1.0"
88
description = 'Official Implementation of "Tree of Thoughts: Deliberate Problem Solving with Large Language Models"'
99
readme = "README.md"
@@ -32,4 +32,4 @@ dependencies = {file = ["requirements.txt"]}
3232
where = ["src"] # list of folders that contain the packages (["."] by default)
3333

3434
[project.urls]
35-
Homepage = "https://github.com/princeton-nlp/tree-of-thought-llm"
35+
Homepage = "https://github.com/princeton-nlp/tree-of-thought-llm"

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66

77
setuptools.setup(
8-
name='tot',
8+
name='tree-of-thoughts-llm',
99
author='Shunyu Yao',
1010
author_email='shunyuyao.cs@gmail.com',
1111
description='Official Implementation of "Tree of Thoughts: Deliberate Problem Solving with Large Language Models"',
@@ -34,4 +34,4 @@
3434
'setuptools',
3535
],
3636
include_package_data=True,
37-
)
37+
)

0 commit comments

Comments
 (0)