together 1.1.2__tar.gz → 1.1.3__tar.gz

{together-1.1.2 → together-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: together
-Version: 1.1.2
+Version: 1.1.3
 Summary: Python client for Together's Cloud Platform!
 Home-page: https://github.com/togethercomputer/together-python
 License: Apache-2.0
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: aiohttp (>=3.9.3,<4.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: eval-type-backport (>=0.1.3,<0.2.0)
+Requires-Dist: eval-type-backport (>=0.1.3,<0.3.0)
 Requires-Dist: filelock (>=3.13.1,<4.0.0)
 Requires-Dist: numpy (>=1.23.5) ; python_version < "3.12"
 Requires-Dist: numpy (>=1.26.0) ; python_version >= "3.12"
@@ -32,32 +32,46 @@ Project-URL: Bug Tracker, https://github.com/togethercomputer/together-python/is
 Project-URL: Repository, https://github.com/togethercomputer/together-python
 Description-Content-Type: text/markdown
 
-The [Together Python Library](https://pypi.org/project/together/) is the official Python client for Together's API platform, providing a convenient way for interacting with the REST APIs and enables easy integrations with Python 3.8+ applications with easy to use synchronous and asynchronous clients.
+<div align="center">
+  <a href="https://www.together.ai/">
+    <img alt="together.ai" height="100px" src="https://assets-global.website-files.com/64f6f2c0e3f4c5a91c1e823a/654693d569494912cfc0c0d4_favicon.svg">
+  </a>
+</div>
 
-# Installation
+# Together Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/together.svg)](https://pypi.org/project/together/)
+[![Discord](https://dcbadge.vercel.app/api/server/9Rk6sSeWEG?style=flat&compact=true)](https://discord.com/invite/9Rk6sSeWEG)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/togethercompute.svg?style=social&label=Follow%20%40togethercompute)](https://twitter.com/togethercompute)
+
+The [Together Python API Library](https://pypi.org/project/together/) is the official Python client for Together's API platform, providing a convenient way for interacting with the REST APIs and enables easy integrations with Python 3.8+ applications with easy to use synchronous and asynchronous clients.
+
+
+
+## Installation
 
 > 🚧
-> The library was rewritten in v1.0.0 released in April of 2024. There were significant changes made.
+> The Library was rewritten in v1.0.0 released in April of 2024. There were significant changes made.
 
-To install Together Python Library from PyPi, simply run:
+To install Together Python Library from PyPI, simply run:
 
 ```shell Shell
 pip install --upgrade together
 ```
 
-## Setting up API Key
+### Setting up API Key
 
 > 🚧 You will need to create an account with [Together.ai](https://api.together.xyz/) to obtain a Together API Key.
 
 Once logged in to the Together Playground, you can find available API keys in [this settings page](https://api.together.xyz/settings/api-keys).
 
-### Setting environment variable
+#### Setting environment variable
 
 ```shell
 export TOGETHER_API_KEY=xxxxx
 ```
 
-### Using the client
+#### Using the client
 
 ```python
 from together import Together
@@ -65,11 +79,11 @@ from together import Together
 client = Together(api_key="xxxxx")
 ```
 
-This library contains both a python library and a CLI. We'll demonstrate how to use both below.
+This repo contains both a Python Library and a CLI. We'll demonstrate how to use both below.
 
-# Usage – Python Client
+## Usage – Python Client
 
-## Chat Completions
+### Chat Completions
 
 ```python
 import os
@@ -84,7 +98,7 @@ response = client.chat.completions.create(
 print(response.choices[0].message.content)
 ```
 
-### Streaming
+#### Streaming
 
 ```python
 import os
@@ -101,7 +115,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content or "", end="", flush=True)
 ```
 
-### Async usage
+#### Async usage
 
 ```python
 import os, asyncio
@@ -130,7 +144,7 @@ async def async_chat_completion(messages):
 asyncio.run(async_chat_completion(messages))
 ```
 
-## Completions
+### Completions
 
 Completions are for code and language models shown [here](https://docs.together.ai/docs/inference-models). Below, a code model example is shown.
 
@@ -143,11 +157,12 @@ client = Together(api_key=os.environ.get("TOGETHER_API_KEY"))
 response = client.completions.create(
     model="codellama/CodeLlama-34b-Python-hf",
     prompt="Write a Next.js component with TailwindCSS for a header component.",
+    max_tokens=200,
 )
 print(response.choices[0].text)
 ```
 
-### Streaming
+#### Streaming
 
 ```python
 import os
@@ -164,7 +179,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content or "", end="", flush=True)
 ```
 
-### Async usage
+#### Async usage
 
 ```python
 import os, asyncio
@@ -193,7 +208,7 @@ async def async_chat_completion(prompts):
 asyncio.run(async_chat_completion(prompts))
 ```
 
-## Image generation
+### Image generation
 
 ```python
 import os
@@ -210,7 +225,7 @@ response = client.images.generate(
 print(response.data[0].b64_json)
 ```
 
-## Embeddings
+### Embeddings
 
 ```python
 from typing import List
@@ -229,7 +244,7 @@ embeddings = get_embeddings(input_texts, model='togethercomputer/m2-bert-80M-8k-
 print(embeddings)
 ```
 
-## Files
+### Files
 
 The files API is used for fine-tuning and allows developers to upload data to fine-tune on. It also has several methods to list all files, retrive files, and delete files. Please refer to our fine-tuning docs [here](https://docs.together.ai/docs/fine-tuning-python).
 
@@ -246,7 +261,7 @@ client.files.retrieve_content(id="file-d0d318cb-b7d9-493a-bd70-1cfe089d3815") #
 client.files.delete(id="file-d0d318cb-b7d9-493a-bd70-1cfe089d3815") # deletes a file
 ```
 
-## Fine-tunes
+### Fine-tunes
 
 The finetune API is used for fine-tuning and allows developers to create finetuning jobs. It also has several methods to list all jobs, retrive statuses and get checkpoints. Please refer to our fine-tuning docs [here](https://docs.together.ai/docs/fine-tuning-python).
 
@@ -273,7 +288,7 @@ client.fine_tuning.list_events(id="ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b") #
 client.fine_tuning.download(id="ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b") # downloads compressed fine-tuned model or checkpoint to local disk
 ```
 
-## Models
+### Models
 
 This lists all the models that Together supports.
 
@@ -289,9 +304,9 @@ for model in models:
     print(model)
 ```
 
-# Usage – CLI
+## Usage – CLI
 
-## Chat Completions
+### Chat Completions
 
 ```bash
 together chat.completions \
@@ -302,7 +317,7 @@ together chat.completions \
 
 The Chat Completions CLI enables streaming tokens to stdout by default. To disable streaming, use `--no-stream`.
 
-## Completions
+### Completions
 
 ```bash
 together completions \
@@ -314,7 +329,7 @@ together completions \
 
 The Completions CLI enables streaming tokens to stdout by default. To disable streaming, use `--no-stream`.
 
-## Image Generations
+### Image Generations
 
 ```bash
 together images generate \
@@ -325,7 +340,7 @@ together images generate \
 
 The image is opened in the default image viewer by default. To disable this, use `--no-show`.
 
-## Files
+### Files
 
 ```bash
 # Help
@@ -350,7 +365,7 @@ together files retrieve-content file-6f50f9d1-5b95-416c-9040-0799b2b4b894
 together files delete file-6f50f9d1-5b95-416c-9040-0799b2b4b894
 ```
 
-## Fine-tuning
+### Fine-tuning
 
 ```bash
 # Help
@@ -377,7 +392,7 @@ together fine-tuning cancel ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b
 together fine-tuning download ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b
 ```
 
-## Models
+### Models
 
 ```bash
 # Help

{together-1.1.2 → together-1.1.3}/README.md

@@ -1,29 +1,43 @@
-The [Together Python Library](https://pypi.org/project/together/) is the official Python client for Together's API platform, providing a convenient way for interacting with the REST APIs and enables easy integrations with Python 3.8+ applications with easy to use synchronous and asynchronous clients.
+<div align="center">
+  <a href="https://www.together.ai/">
+    <img alt="together.ai" height="100px" src="https://assets-global.website-files.com/64f6f2c0e3f4c5a91c1e823a/654693d569494912cfc0c0d4_favicon.svg">
+  </a>
+</div>
 
-# Installation
+# Together Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/together.svg)](https://pypi.org/project/together/)
+[![Discord](https://dcbadge.vercel.app/api/server/9Rk6sSeWEG?style=flat&compact=true)](https://discord.com/invite/9Rk6sSeWEG)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/togethercompute.svg?style=social&label=Follow%20%40togethercompute)](https://twitter.com/togethercompute)
+
+The [Together Python API Library](https://pypi.org/project/together/) is the official Python client for Together's API platform, providing a convenient way for interacting with the REST APIs and enables easy integrations with Python 3.8+ applications with easy to use synchronous and asynchronous clients.
+
+
+
+## Installation
 
 > 🚧
-> The library was rewritten in v1.0.0 released in April of 2024. There were significant changes made.
+> The Library was rewritten in v1.0.0 released in April of 2024. There were significant changes made.
 
-To install Together Python Library from PyPi, simply run:
+To install Together Python Library from PyPI, simply run:
 
 ```shell Shell
 pip install --upgrade together
 ```
 
-## Setting up API Key
+### Setting up API Key
 
 > 🚧 You will need to create an account with [Together.ai](https://api.together.xyz/) to obtain a Together API Key.
 
 Once logged in to the Together Playground, you can find available API keys in [this settings page](https://api.together.xyz/settings/api-keys).
 
-### Setting environment variable
+#### Setting environment variable
 
 ```shell
 export TOGETHER_API_KEY=xxxxx
 ```
 
-### Using the client
+#### Using the client
 
 ```python
 from together import Together
@@ -31,11 +45,11 @@ from together import Together
 client = Together(api_key="xxxxx")
 ```
 
-This library contains both a python library and a CLI. We'll demonstrate how to use both below.
+This repo contains both a Python Library and a CLI. We'll demonstrate how to use both below.
 
-# Usage – Python Client
+## Usage – Python Client
 
-## Chat Completions
+### Chat Completions
 
 ```python
 import os
@@ -50,7 +64,7 @@ response = client.chat.completions.create(
 print(response.choices[0].message.content)
 ```
 
-### Streaming
+#### Streaming
 
 ```python
 import os
@@ -67,7 +81,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content or "", end="", flush=True)
 ```
 
-### Async usage
+#### Async usage
 
 ```python
 import os, asyncio
@@ -96,7 +110,7 @@ async def async_chat_completion(messages):
 asyncio.run(async_chat_completion(messages))
 ```
 
-## Completions
+### Completions
 
 Completions are for code and language models shown [here](https://docs.together.ai/docs/inference-models). Below, a code model example is shown.
 
@@ -109,11 +123,12 @@ client = Together(api_key=os.environ.get("TOGETHER_API_KEY"))
 response = client.completions.create(
     model="codellama/CodeLlama-34b-Python-hf",
     prompt="Write a Next.js component with TailwindCSS for a header component.",
+    max_tokens=200,
 )
 print(response.choices[0].text)
 ```
 
-### Streaming
+#### Streaming
 
 ```python
 import os
@@ -130,7 +145,7 @@ for chunk in stream:
     print(chunk.choices[0].delta.content or "", end="", flush=True)
 ```
 
-### Async usage
+#### Async usage
 
 ```python
 import os, asyncio
@@ -159,7 +174,7 @@ async def async_chat_completion(prompts):
 asyncio.run(async_chat_completion(prompts))
 ```
 
-## Image generation
+### Image generation
 
 ```python
 import os
@@ -176,7 +191,7 @@ response = client.images.generate(
 print(response.data[0].b64_json)
 ```
 
-## Embeddings
+### Embeddings
 
 ```python
 from typing import List
@@ -195,7 +210,7 @@ embeddings = get_embeddings(input_texts, model='togethercomputer/m2-bert-80M-8k-
 print(embeddings)
 ```
 
-## Files
+### Files
 
 The files API is used for fine-tuning and allows developers to upload data to fine-tune on. It also has several methods to list all files, retrive files, and delete files. Please refer to our fine-tuning docs [here](https://docs.together.ai/docs/fine-tuning-python).
 
@@ -212,7 +227,7 @@ client.files.retrieve_content(id="file-d0d318cb-b7d9-493a-bd70-1cfe089d3815") #
 client.files.delete(id="file-d0d318cb-b7d9-493a-bd70-1cfe089d3815") # deletes a file
 ```
 
-## Fine-tunes
+### Fine-tunes
 
 The finetune API is used for fine-tuning and allows developers to create finetuning jobs. It also has several methods to list all jobs, retrive statuses and get checkpoints. Please refer to our fine-tuning docs [here](https://docs.together.ai/docs/fine-tuning-python).
 
@@ -239,7 +254,7 @@ client.fine_tuning.list_events(id="ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b") #
 client.fine_tuning.download(id="ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b") # downloads compressed fine-tuned model or checkpoint to local disk
 ```
 
-## Models
+### Models
 
 This lists all the models that Together supports.
 
@@ -255,9 +270,9 @@ for model in models:
     print(model)
 ```
 
-# Usage – CLI
+## Usage – CLI
 
-## Chat Completions
+### Chat Completions
 
 ```bash
 together chat.completions \
@@ -268,7 +283,7 @@ together chat.completions \
 
 The Chat Completions CLI enables streaming tokens to stdout by default. To disable streaming, use `--no-stream`.
 
-## Completions
+### Completions
 
 ```bash
 together completions \
@@ -280,7 +295,7 @@ together completions \
 
 The Completions CLI enables streaming tokens to stdout by default. To disable streaming, use `--no-stream`.
 
-## Image Generations
+### Image Generations
 
 ```bash
 together images generate \
@@ -291,7 +306,7 @@ together images generate \
 
 The image is opened in the default image viewer by default. To disable this, use `--no-show`.
 
-## Files
+### Files
 
 ```bash
 # Help
@@ -316,7 +331,7 @@ together files retrieve-content file-6f50f9d1-5b95-416c-9040-0799b2b4b894
 together files delete file-6f50f9d1-5b95-416c-9040-0799b2b4b894
 ```
 
-## Fine-tuning
+### Fine-tuning
 
 ```bash
 # Help
@@ -343,7 +358,7 @@ together fine-tuning cancel ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b
 together fine-tuning download ft-c66a5c18-1d6d-43c9-94bd-32d756425b4b
 ```
 
-## Models
+### Models
 
 ```bash
 # Help

{together-1.1.2 → together-1.1.3}/pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "together"
-version = "1.1.2"
+version = "1.1.3"
 authors = [
     "Together AI <support@together.ai>"
 ]
@@ -36,7 +36,7 @@ tabulate = "^0.9.0"
 pydantic = "^2.6.3"
 aiohttp = "^3.9.3"
 filelock = "^3.13.1"
-eval-type-backport = "^0.1.3"
+eval-type-backport = ">=0.1.3,<0.3.0"
 click = "^8.1.7"
 pillow = "^10.3.0"
 pyarrow = ">=10.0.1"
@@ -50,7 +50,7 @@ optional = true
 
 [tool.poetry.group.quality.dependencies]
 black = ">=23.1,<25.0"
-ruff = "^0.3.2"
+ruff = ">=0.3.2,<0.5.0"
 types-tqdm = "^4.65.0.0"
 types-tabulate = "^0.9.0.3"
 pre-commit = "3.5.0"
@@ -66,6 +66,13 @@ pytest = ">=7.4.2,<9.0.0"
 pytest-watch = "^4.2.0"
 tox = "^4.14.1"
 
+[tool.poetry.group.examples]
+optional = true
+
+[tool.poetry.group.examples.dependencies]
+datasets = "^2.18.0"
+transformers = "^4.39.3"
+
 
 [tool.poetry.urls]
 "Homepage" = "https://github.com/togethercomputer/together-python"

{together-1.1.2 → together-1.1.3}/src/together/types/chat_completions.py

@@ -20,6 +20,7 @@ class MessageRole(str, Enum):
     ASSISTANT = "assistant"
     SYSTEM = "system"
     USER = "user"
+    TOOL = "tool"
 
 
 class ResponseFormatType(str, Enum):