Useful error handling (#17)

* init

* black ruff fixes

* better readme completion

* type fix

* simpler feedback check

* black ruff changes

* no_implicit_optional

* mypy errors addressed

* different mypy version

* black ruff

* typo in readme fixed

* typo in readme fixed

* typo in readme fixed

* update example

* Update README.md

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* unrealted typo wether to whether in complete.py

* Update src/together/commands/files.py

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* Update src/together/complete.py

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* Update src/together/files.py

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* Update src/together/files.py

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* Update src/together/finetune.py

Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

* remove logger

* incorporate justus's suggestions

* reconcile suggestions



* ruf black fixes to reverse of cleanup

---------

Co-authored-by: Carson Lam <carsonlam@Carsons-MacBook-Pro-2.local>
Co-authored-by: Justus Calvin <justusc@users.noreply.github.com>

Author: 3 people

README.md

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "together"
-version = "0.1.3"
+version = "0.1.4"
 authors = [
   { name="Together Computer", email="community@together.xyz" },
 ]

pyproject.toml

@@ -1,6 +1,12 @@
 import os
 import urllib.parse
 
+from .config import (
+    finetune_model_names,
+    jokes_list,
+    min_samples,
+    model_info_dict,
+)
 from .version import VERSION
 
 
@@ -46,4 +52,8 @@
     "Files",
     "Finetune",
     "Image",
+    "model_info_dict",
+    "finetune_model_names",
+    "min_samples",
+    "jokes_list",
 ]

src/together/__init__.py

@@ -13,6 +13,7 @@ def add_parser(subparsers: argparse._SubParsersAction[argparse.ArgumentParser])
     child_parsers = parser.add_subparsers(required=True)
 
     _add_list(child_parsers)
+    _add_check(child_parsers)
     _add_upload(child_parsers)
     _add_delete(child_parsers)
     _add_retrieve(child_parsers)
@@ -24,6 +25,26 @@ def _add_list(parser: argparse._SubParsersAction[argparse.ArgumentParser]) -> No
     subparser.set_defaults(func=_run_list)
 
 
+def _add_check(parser: argparse._SubParsersAction[argparse.ArgumentParser]) -> None:
+    subparser = parser.add_parser("check")
+    subparser.add_argument(
+        "file",
+        metavar="FILENAME",
+        help="Local file to upload",
+        type=str,
+    )
+    subparser.add_argument(
+        "--model",
+        "-m",
+        default=None,
+        metavar="MODELNAME",
+        help="check data for this model's special tokens",
+        type=str,
+        required=False,
+    )
+    subparser.set_defaults(func=_run_check)
+
+
 def _add_upload(parser: argparse._SubParsersAction[argparse.ArgumentParser]) -> None:
     subparser = parser.add_parser("upload")
     subparser.add_argument(
@@ -32,6 +53,21 @@ def _add_upload(parser: argparse._SubParsersAction[argparse.ArgumentParser]) ->
         help="Local file to upload",
         type=str,
     )
+    subparser.add_argument(
+        "--no-check",
+        default=False,
+        action="store_true",
+        help="Indicates whether to disable checking",
+    )
+    subparser.add_argument(
+        "--model",
+        "-m",
+        default=None,
+        metavar="MODELNAME",
+        help="check data for this model's special tokens",
+        type=str,
+        required=False,
+    )
     subparser.set_defaults(func=_run_upload)
 
 
@@ -87,9 +123,15 @@ def _run_list(args: argparse.Namespace) -> None:
     print(json.dumps(response, indent=4))
 
 
+def _run_check(args: argparse.Namespace) -> None:
+    files = Files()
+    response = files.check(args.file, args.model)
+    print(json.dumps(response, indent=4))
+
+
 def _run_upload(args: argparse.Namespace) -> None:
     files = Files()
-    response = files.upload(args.file)
+    response = files.upload(file=args.file, check=not args.no_check, model=args.model)
     print(json.dumps(response, indent=4))
 
 

src/together/commands/files.py

@@ -65,7 +65,14 @@ def create(
 
         if response.status_code == 429:
             logger.critical(
-                f"No running instances for {model}. You can start an instance by navigating to the Together Playground at api.together.ai"
+                f"""No running instances for {model}.
+                You can start an instance with one of the following methods:
+                  1. navigating to the Together Playground at api.together.ai
+                  2. starting one in python using together.Models.start(model_name)
+                  3. `$ together models start <MODLE_NAME>` at the command line.
+                See `together.Models.list()` in python or `$ together models list` in command line
+                to get an updated list of valid model names.
+                """
             )
             raise together.InstanceError(model=model)
 
@@ -140,7 +147,14 @@ def create_streaming(
                     yield text
         elif response.status_code == 429:
             logger.critical(
-                f"No running instances for {model}. You can start an instance by navigating to the Together Playground at api.together.ai"
+                f"""No running instances for {model}.
+                You can start an instance with one of the following methods:
+                  1. navigating to the Together Playground at api.together.ai
+                  2. starting one in python using together.Models.start(model_name)
+                  3. `$ together models start <MODLE_NAME>` at the command line.
+                See `together.Models.list()` in python or `$ together models list` in command line
+                to get an updated list of valid model names.
+                """
             )
             raise together.InstanceError(model=model)
         else: