Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: optimize the API invocation of README #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: optimize the API invocation of README #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ Add ` OPENAI_API_KEY='API KEY'` in the .env!


## Method2
or:

```pip install tree-of-thoughts ```

Expand All @@ -55,10 +54,7 @@ Navigate to the repository folder: ```cd tree-of-thoughts```
Create a Python script (e.g., example.py) and import the necessary classes:

``` python
import os
from tree_of_thoughts.openaiModels import OpenAILanguageModel
from tree_of_thoughts.treeofthoughts import TreeofThoughts
from tree_of_thoughts.huggingModel import HuggingLanguageModel
from tree_of_thoughts import TreeofThoughts, OptimizedOpenAILanguageModel

use_v2 = False

Expand Down Expand Up @@ -94,7 +90,7 @@ convergence_threshold = 0.01 #determining when the search process has converged
convergence_count = 5 # number of searchers to be considered converged
#read documentation for more

#call the solve emthod with the input problem and other params
#call the solve method with the input problem and other params
solution = tree_of_thoughts.solve(input_problem, k, T, b, vth, timeout, confidence, max_iterations, convergence_threshold, convergence_count)


Expand Down Expand Up @@ -198,7 +194,7 @@ python3 huggingfaceExample.py
```

```python
from tree_of_thoughts.tree_of_thoughts import HuggingLanguageModel
from tree_of_thoughts import HuggingLanguageModel

model_name="gpt2"
model_tokenizer="your tokenizer"
Expand Down