diff --git a/README.md b/README.md index 1b8d4d0..b06053c 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,24 @@ Possible use cases may include: ## Installation -Under active development. Coming to `PyPI` soon. Currently you can run `datasetGPT` by cloning this repository as described [here](#contributing). +``` +pip install datasetGPT +``` + +Most of the generation features rely on third-party APIs. Install their respective packages: + +``` +pip install openai cohere petals +``` ## Usage examples ### Inference LLMs at scale ```bash +export OPENAI_API_KEY="..." +export COHERE_API_KEY="..." + datasetGPT texts \ --prompt "If {country} was a planet in the Star Wars universe it would be called" \ --backend "openai|text-davinci-003" \ @@ -140,6 +151,8 @@ for conversation in conversations_generator: ## Contributing +> Still under active development. + Contributions will be highly appreciated. Currently these features are under development: - [x] `datasetGPT conversations` - Make two ChatGPT agents talk with one another and record the conversation history. - [x] `datasetGPT texts` - Inference different LLMs with a given input prompt and generate multiple outputs by varying parameters. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..0f8d1de --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ['setuptools>=61.0'] +build-backend = 'setuptools.build_meta' \ No newline at end of file diff --git a/setup.py b/setup.py index a81a3d6..04facde 100644 --- a/setup.py +++ b/setup.py @@ -1,19 +1,25 @@ from distutils.core import setup +from setuptools import find_packages + +with open("README.md", "r", encoding = "utf-8") as readme: + long_description = readme.read() setup( name="datasetGPT", - packages=["datasetGPT"], version="0.0.1", description="Generate textual and conversational datasets with LLMs.", + long_description = long_description, + long_description_content_type = "text/markdown", author="Radostin Cholakov", author_email="radicho123@gmail.com", url="https://github.com/radi-cho/datasetGPT", # download_url="https://github.com/radi-cho/datasetGPT/archive/v0.0.1.tar.gz", keywords=["dataset", "llm", "langchain", "openai"], + package_dir={"": "src"}, + packages = find_packages(where="src"), install_requires=[ - "langchain", - "openai", - "click" + "langchain>=0.0.113", + "click>=8.1" ], entry_points={ "console_scripts": [ diff --git a/datasetGPT/__init__.py b/src/datasetGPT/__init__.py similarity index 100% rename from datasetGPT/__init__.py rename to src/datasetGPT/__init__.py diff --git a/datasetGPT/__main__.py b/src/datasetGPT/__main__.py similarity index 100% rename from datasetGPT/__main__.py rename to src/datasetGPT/__main__.py diff --git a/datasetGPT/base.py b/src/datasetGPT/base.py similarity index 100% rename from datasetGPT/base.py rename to src/datasetGPT/base.py diff --git a/datasetGPT/cli.py b/src/datasetGPT/cli.py similarity index 100% rename from datasetGPT/cli.py rename to src/datasetGPT/cli.py diff --git a/datasetGPT/conversations.py b/src/datasetGPT/conversations.py similarity index 100% rename from datasetGPT/conversations.py rename to src/datasetGPT/conversations.py diff --git a/datasetGPT/outputs.py b/src/datasetGPT/outputs.py similarity index 100% rename from datasetGPT/outputs.py rename to src/datasetGPT/outputs.py diff --git a/datasetGPT/texts.py b/src/datasetGPT/texts.py similarity index 100% rename from datasetGPT/texts.py rename to src/datasetGPT/texts.py