Prepare pip package

This commit is contained in:
Nils Blach 2023-08-23 16:12:18 +02:00
parent 2f4b828aef
commit 6e58415a25
2 changed files with 11 additions and 5 deletions

View File

@ -14,14 +14,16 @@ In order to use this framework, you need to have a working installation of Pytho
### Installing GoT
If you are a user and you just want to use `graph_of_thoughts`, you can install it directly from the source with pip.
If you are a developer and you want to modify the code, you can install it in editable mode by adding the `-e` flag to the pip command.
Activate your Python environment (if any), and run:
Before running either of the following two installation methods, make sure to activate your Python environment (if any) beforehand.
If you are a user and you just want to use `graph_of_thoughts`, you can install it directly from from PyPI:
```bash
pip install graph-of-thoughts
```
If you are a developer and you want to modify the code, you can install it in editable mode from source:
```bash
git clone https://github.com/spcl/graph-of-thoughts.git
cd graph-of-thoughts
pip install .
pip install -e .
```
### Configuring the LLM

View File

@ -13,6 +13,7 @@ authors = [
]
description = "Python package for Graph of Thoughts that enables solving elaborate problems with Large Language Models"
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Python :: 3",
@ -29,4 +30,7 @@ dependencies = [
"transformers>=4.31.0",
]
[project.urls]
Homepage = "https://github.com/spcl/graph-of-thoughts"
[project.scripts]