together 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

together/__init__.py

@@ -16,9 +16,11 @@ api_base_complete = urllib.parse.urljoin(api_base, "/api/inference")
 api_base_files = urllib.parse.urljoin(api_base, "/v1/files/")
 api_base_finetune = urllib.parse.urljoin(api_base, "/v1/fine-tunes/")
 api_base_instances = urllib.parse.urljoin(api_base, "instances/")
+api_base_embeddings = urllib.parse.urljoin(api_base, "api/v1/embeddings")
 
 default_text_model = "togethercomputer/RedPajama-INCITE-7B-Chat"
 default_image_model = "runwayml/stable-diffusion-v1-5"
+default_embedding_model = "togethercomputer/bert-base-uncased"
 log_level = "WARNING"
 
 MISSING_API_KEY_MESSAGE = """TOGETHER_API_KEY not found.
@@ -31,6 +33,7 @@ BACKOFF_FACTOR = 0.2
 min_samples = 100
 
 from .complete import Complete
+from .embeddings import Embeddings
 from .error import *
 from .files import Files
 from .finetune import Finetune
@@ -45,13 +48,16 @@ __all__ = [
     "api_base_files",
     "api_base_finetune",
     "api_base_instances",
+    "api_base_embeddings",
     "default_text_model",
     "default_image_model",
+    "default_embedding_model",
     "Models",
     "Complete",
     "Files",
     "Finetune",
     "Image",
+    "Embeddings",
     "MAX_CONNECTION_RETRIES",
     "MISSING_API_KEY_MESSAGE",
     "BACKOFF_FACTOR",

together/cli/cli.py

@@ -2,7 +2,7 @@
 import argparse
 
 import together
-from together.commands import chat, complete, files, finetune, image, models
+from together.commands import chat, complete, embeddings, files, finetune, image, models
 from together.utils import get_logger
 
 
@@ -49,6 +49,7 @@ def main() -> None:
     image.add_parser(subparser)
     files.add_parser(subparser)
     finetune.add_parser(subparser)
+    embeddings.add_parser(subparser)
 
     args = parser.parse_args()
 

together/commands/embeddings.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+import argparse
+import json
+
+import together
+from together import Embeddings
+from together.utils import get_logger
+
+
+logger = get_logger(str(__name__))
+
+
+def add_parser(subparsers: argparse._SubParsersAction[argparse.ArgumentParser]) -> None:
+    COMMAND_NAME = "embeddings"
+    subparser = subparsers.add_parser(COMMAND_NAME)
+
+    subparser.add_argument(
+        "input",
+        metavar="INPUT",
+        default=None,
+        type=str,
+        help="A string providing context for the model to embed",
+    )
+
+    subparser.add_argument(
+        "--model",
+        "-m",
+        default=together.default_embedding_model,
+        type=str,
+        help=f"The name of the model to query. Default={together.default_text_model}",
+    )
+    subparser.set_defaults(func=_run_complete)
+
+
+def _run_complete(args: argparse.Namespace) -> None:
+    embeddings = Embeddings()
+
+    try:
+        response = embeddings.create(
+            input=args.input,
+            model=args.model,
+        )
+
+        print(json.dumps(response, indent=4))
+    except together.AuthenticationError:
+        logger.critical(together.MISSING_API_KEY_MESSAGE)
+        exit(0)

together/embeddings.py

@@ -0,0 +1,35 @@
+from typing import Any, Dict, Optional
+
+import together
+from together.utils import create_post_request, get_logger
+
+
+logger = get_logger(str(__name__))
+
+
+class Embeddings:
+    @classmethod
+    def create(
+        self,
+        input: str,
+        model: Optional[str] = "",
+    ) -> Dict[str, Any]:
+        if model == "":
+            model = together.default_embedding_model
+
+        parameter_payload = {
+            "input": input,
+            "model": model,
+        }
+
+        # send request
+        response = create_post_request(
+            url=together.api_base_embeddings, json=parameter_payload
+        )
+
+        try:
+            response_json = dict(response.json())
+
+        except Exception as e:
+            raise together.JSONError(e, http_status=response.status_code)
+        return response_json

{together-0.2.6.dist-info → together-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: together
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python client for Together's Cloud Platform!
 Home-page: https://github.com/togethercomputer/together
 License: Apache-2.0
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: sseclient-py (>=1.7.2,<2.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
@@ -353,7 +354,34 @@ Job creation details:
 Do you want to submit the job? [y/N]
 ```
 
-The response `resp` has alot of information for you that you can retrieve later with `together.Finetune.retrieve` using the `fine_tune_id` for this job. You can find this `fine_tune_id` in `resp['id']` and use it to check in on how your finetune job is doing. 
+Here is an example of only part of the `resp` response to highlight some of the useful information about your finetune job.
+
+```
+{   'Suffix': 'my-demo-finetune',
+    'batch_size': 4,
+    'created_at': '2023-11-07T19:04:30.579Z',
+    'enable_checkpoints': False,
+    'epochs_completed': 0,
+    'events': [   {   'checkpoint_path': '',
+                      'created_at': '2023-11-07T19:04:30.579Z',
+                      'hash': '',
+                      'level': '',
+                      'message': 'Fine tune request created',
+                      'model_path': '',
+                      'object': 'fine-tune-event',
+                      'param_count': 0,
+                      'token_count': 0,
+                      'training_offset': 0,
+                      'type': 'JOB_PENDING',
+                      'wandb_url': ''}],
+    'id': 'ft-494cbd75-3057-44b4-8186-045c14be8d03',
+    'learning_rate': 1e-05,
+    'model': 'togethercomputer/RedPajama-INCITE-Chat-3B-v1',
+    'model_output_name': 'carson/RedPajama-INCITE-Chat-3B-v1-my-demo-finetune-2023-11-07-19-04-30',
+    'wandb_url': '...'}
+```
+
+The response `resp` has alot of information for you that you can retrieve again later with `together.Finetune.retrieve` using the `fine_tune_id` for this job. You can find this `fine_tune_id` in `resp['id']` and use it to check in on how your finetune job is doing. 
 
 ```python
 print(together.Finetune.retrieve(fine_tune_id=fine_tune_id)) # retrieves information on finetune event
@@ -362,14 +390,16 @@ print(together.Finetune.is_final_model_available(fine_tune_id=fine_tune_id)) # T
 print(together.Finetune.get_checkpoints(fine_tune_id=fine_tune_id)) # list of checkpoints
 ```
 
-The `get_job_status` should change from `pending` to `running` to `completed` as `is_final_model_available` changes from `False` to `True`. Once the final model is available, you should be able to see your new model under `together.Models.list()` with a naming convention that includes your name, the `fine_tune_id`, the date and time, like this: 
+The `get_job_status` should change from `pending` to `running` to `completed` as `is_final_model_available` changes from `False` to `True`. Once in the `running` state, you can retrieve the `wandb_url` and visit this page to monitor the learning progress of this finetune job. 
 
-`carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09`
+Under `model_output_name` you will find the unique name that will be given to the new finetuned model whose creation is underway. This name includes your username, the base model name, your suffix and the datetime the job was created. In addition to using the API to track the status as shown above, you can use `model_output_name` to find helpful features related to the new model within the Jobs section of your account on our webpage.
+
+Once the final model is available, you should be able to see your new model under `together.Models.list()` under `model_output_name`.
 
 Now you can download your model using `together.Finetune.download(fine_tune_id)` or start using your model on our inference engine (may take a few minutes after finetuning to become available) by first starting your new model instance:
 
 ```
-together.Models.start("carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09")
+together.Models.start(model_output_name)
 ```
 
 then calling it to do completions:
@@ -377,14 +407,14 @@ then calling it to do completions:
 ```
 output = together.Complete.create(
   prompt = "Isaac Asimov's Three Laws of Robotics are:\n\n1. ", 
-  model = "carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09", 
+  model = model_output_name, 
 )
 ```
 
 To check whether your model is finished deploying, you can use the `Models.ready` like so:
 
 ```
-together.Models.ready("carlton/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09")
+together.Models.ready(model_output_name)
 ```
 
 ```
@@ -450,6 +480,16 @@ print(output_text)
 Space Robots are a great way to get your kids interested in science. After all, they are the future!
 ```
 
+## Embeddings API
+
+Embeddings are vector representations of sequences. You can use these vectors for measuring the overall similarity between texts. Embeddings are useful for tasks such as search and retrieval. 
+
+```python
+resp = together.Embeddings.create("embed this sentence into a single vector", model="togethercomputer/bert-base-uncased")
+
+print(resp['data'][0]['embedding']) # [0.06659205, 0.07896972, 0.007910785 ........]
+```
+
 ## Colab Tutorial
 
 Follow along in our Colab (Google Colaboratory) Notebook Tutorial [Example Finetuning Project](https://colab.research.google.com/drive/11DwtftycpDSgp3Z1vnV-Cy68zvkGZL4K?usp=sharing).
@@ -509,6 +549,9 @@ together finetune download ft-dd93c727-f35e-41c2-a370-7d55b54128fa
 
 # inference using your new finetuned model (with new finetuned model name from together models list)
 together complete "Space robots are" -m yourname/ft-dd93c727-f35e-41c2-a370-7d55b54128fa-2023-08-16-10-15-09
+
+# create an embedding from your input sequence
+together embeddings "embed this sentence into a single vector" -m togethercomputer/bert-base-uncased
 ```
 
 ## Contributing

{together-0.2.6.dist-info → together-0.2.7.dist-info}/RECORD

@@ -1,14 +1,16 @@
-together/__init__.py,sha256=-sxEMYnKy_eY-O1zhBBLro6vTFiv0v2oz4BauIsGuh4,1449
+together/__init__.py,sha256=vhGyzirz_S-3sUHvLX4cL-xlzL1439chQcJI-3fjXww,1697
 together/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-together/cli/cli.py,sha256=Zzd7wspatS5ijdM17DrXa1DDRVBj0osI6I07wbQnjZg,1606
+together/cli/cli.py,sha256=aALVTU7hhPdiSm0P175UXCwkBphP5DMi3mLEJ10K-1o,1655
 together/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 together/commands/chat.py,sha256=5hcTGiS0er7WO5UpFnIkWnOwWFZfppQ_5RvExVgkz30,4297
 together/commands/complete.py,sha256=ndm9hdTcnav4uetgmvIfTdtwTthshX2LOvx-f46pU58,5512
+together/commands/embeddings.py,sha256=HzBh_SNtlmeUH3RuCNhPCLPjw1X_gSKgPu6-lRqs3P4,1181
 together/commands/files.py,sha256=nlM21PIklCD1ebc9Vlw5KKr8tyqwwfS4zw5BEj9UXAg,5890
 together/commands/finetune.py,sha256=4f-VZWnfZeRs39MvTnu_kYpoI53bpSmYtVbboY4N-C8,11240
 together/commands/image.py,sha256=2JWI597OO77nPJR9cBiJspZ74ijrCtZgcAF538H_AMA,4007
 together/commands/models.py,sha256=MOkn_IZw4NnhnQyFHAmRvXsqT9_tz26xLTD7mTuDO_E,6201
 together/complete.py,sha256=iM9DRxK5zDIqM7vcbfwymLTZ0YSSXpfj8Ks2O3A8xnM,3356
+together/embeddings.py,sha256=v7p4lSS6wQf6e2jncBeJQg3l-e6ae4kgVrMnvIfmnN8,815
 together/error.py,sha256=OlEuDG1E-O__fvKpwQ3mL3QxGNJ-OsMgmKwp-aJiG-4,2631
 together/files.py,sha256=1NFojMHHV8HfND2NmMVHhZcQljRM-iMLwXocnMJBRt0,12256
 together/finetune.py,sha256=VwYbhSwqwh0emCanHCoFTA9yu1zg4-0tBQQH9KFxfdA,12187
@@ -18,8 +20,8 @@ together/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 together/tools/conversation.py,sha256=m_rt0VBkpweHV0DXZwQmaXeGGfnUr96fHqdRjabfLBk,1859
 together/utils.py,sha256=as0HrLpkEei223IvKue0GujCKmjLn6EISxm1mq8tnEk,5268
 together/version.py,sha256=p03ivHyE0SyWU4jAnRTBi_sOwywVWoZPU4g2gzRgG-Y,126
-together-0.2.6.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-together-0.2.6.dist-info/METADATA,sha256=FifMgm14ynnwjb_JH1_Vh0NEegH3QPnUcShFUlGxtbw,25008
-together-0.2.6.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-together-0.2.6.dist-info/entry_points.txt,sha256=G-b5NKW6lUUf1V1fH8IPTBb7jXnK7lhbX9H1zTEJXPs,50
-together-0.2.6.dist-info/RECORD,,
+together-0.2.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+together-0.2.7.dist-info/METADATA,sha256=XILawH21LHgLb_fsvm-vgtS59LMzFcmkN8bymAfSDWk,27029
+together-0.2.7.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+together-0.2.7.dist-info/entry_points.txt,sha256=G-b5NKW6lUUf1V1fH8IPTBb7jXnK7lhbX9H1zTEJXPs,50
+together-0.2.7.dist-info/RECORD,,

{together-0.2.6.dist-info → together-0.2.7.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: poetry-core 1.8.1
 Root-Is-Purelib: true
 Tag: py3-none-any