ellf-cli 19.0.0__tar.gz → 19.0.4__tar.gz

{ellf_cli-19.0.0/ellf_cli.egg-info → ellf_cli-19.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ellf-cli
-Version: 19.0.0
+Version: 19.0.4
 Summary: Ellf Command Line Interface
 Home-page: https://prodi.gy
 Author: ExplosionAI GmbH

{ellf_cli-19.0.0 → ellf_cli-19.0.4}/README.md

@@ -1307,23 +1307,23 @@ Mint a fresh 90-day token for an existing service. Issuing a new token does not
 
 ### `ellf sessions`
 
-View, disable and activate a task's annotation sessions
+View, exclude and activate a task's annotation sessions
 
 #### `ellf sessions list`
 
-List a task's annotation sessions, with how much each annotated and whether it was disabled
+List a task's annotation sessions, with how much each annotated, how much of that the dataset still holds, and whether it was excluded
 
 | Argument | Type | Description | Default |
 | --- | --- | --- | --- |
 | `name_or_id` | `Union[str, UUID]` | Name or ID of the task |  |
 | `--project` | `str` | Name, slug, or ID of task's project or the last project if not set | `None` |
 | `--cluster` | `str` | Name, slug, or ID of the cluster to search for task name (or the last cluster if not set) | `None` |
-| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'annotator', 'started', 'annotations', 'status'] | `['id', 'annotator', 'started', 'annotations', 'status']` |
+| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'annotator', 'started', 'annotated', 'active', 'status'] | `['id', 'annotator', 'started', 'annotated', 'active', 'status']` |
 | `--json` | `bool` | Output the result as JSON | `False` |
 
-#### `ellf sessions disable`
+#### `ellf sessions exclude`
 
-Disable an annotation session: take its examples out of the task's dataset, so training and exports leave them out and their tasks are served again. They still count as the annotator's work
+Exclude an annotation session: take its examples out of the task's dataset, so training and exports leave them out and their tasks are served again. They still count as the annotator's work
 
 | Argument | Type | Description | Default |
 | --- | --- | --- | --- |
@@ -1332,7 +1332,7 @@ Disable an annotation session: take its examples out of the task's dataset, so t
 
 #### `ellf sessions activate`
 
-Activate a disabled annotation session: put its examples back into the task's dataset
+Activate an excluded annotation session: put its examples back into the task's dataset
 
 | Argument | Type | Description | Default |
 | --- | --- | --- | --- |
@@ -1383,7 +1383,7 @@ List the tasks in a project. Uses your default project unless --project is given
 | Argument | Type | Description | Default |
 | --- | --- | --- | --- |
 | `--project` | `str` | Name, slug, or ID of task's project or the last project if not set | `None` |
-| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'created', 'updated', 'project_id', 'cluster_id', 'name', 'recipe_name', 'recipe_title', 'project_name', 'error', 'plan', 'job_type', 'cli_command', 'created_by_user', 'state'] | `['id', 'name', 'state']` |
+| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'created', 'updated', 'project_id', 'cluster_id', 'name', 'recipe_name', 'recipe_title', 'project_name', 'error', 'plan', 'job_type', 'cli_command', 'last_execution_started', 'created_by_user', 'state'] | `['id', 'name', 'state']` |
 | `--json` | `bool` | Output the result as JSON | `False` |
 
 #### `ellf tasks info`
@@ -1395,7 +1395,7 @@ Print information about a task on the cluster
 | `name_or_id` | `Union[str, UUID]` | Name or ID of the task |  |
 | `--project` | `str` | Name, slug, or ID of task's project or the last project if not set | `None` |
 | `--cluster` | `str` | Name, slug, or ID of the cluster to search for task name (or the last cluster if not set) | `None` |
-| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'created', 'updated', 'project_id', 'cluster_id', 'name', 'recipe_name', 'recipe_title', 'project_name', 'error', 'plan', 'job_type', 'cli_command', 'created_by_user', 'last_execution_id', 'related_actions', 'url_logs', 'url'] | `None` |
+| `--select` | `list[str]` | Comma-separated fields to select and show in output. Available: ['id', 'created', 'updated', 'project_id', 'cluster_id', 'name', 'recipe_name', 'recipe_title', 'project_name', 'error', 'plan', 'job_type', 'cli_command', 'last_execution_started', 'created_by_user', 'last_execution_id', 'related_actions', 'url_logs', 'url'] | `None` |
 | `--json` | `bool` | Output the result as JSON | `False` |
 
 #### `ellf tasks logs`

{ellf_cli-19.0.0 → ellf_cli-19.0.4}/ellf_cli/commands/datasets.py

@@ -164,6 +164,9 @@ def export(
     cluster_id = auth.cluster_id
 
     dataset = resolve_dataset(name_or_id, cluster_id=cluster_id)
+    legacy = auth.broker_client.datasets.total_example_count(dataset.name).legacy
+    if legacy:
+        raise CLIError(Messages.E066.format(name=dataset.name, count=legacy))
 
     def get_examples_page(page: int):
         return auth.broker_client.datasets.read_examples(

{ellf_cli-19.0.0 → ellf_cli-19.0.4}/ellf_cli/commands/sessions.py

@@ -2,7 +2,7 @@
 
 A task's annotations live in the cluster's Prodigy database, where every
 PAM session (one sitting of one annotator) has a dataset of its own named
-``{dataset}-{task_id}-{annotator_id}-{session_id}``. Disabling a session
+``{dataset}-{task_id}-{annotator_id}-{session_id}``. Excluding a session
 takes its examples out of the task's dataset while keeping them in that
 session dataset.
 """
@@ -20,7 +20,7 @@ from ..query import resolve_task
 from ..ui import print_mutation_result, print_table_with_select
 from ._state import get_auth_state
 
-SESSION_FIELDS = ["id", "annotator", "started", "annotations", "status"]
+SESSION_FIELDS = ["id", "annotator", "started", "annotated", "active", "status"]
 
 
 def _sitting_name(
@@ -45,31 +45,34 @@ def list(
     select: builtins.list[str] = SESSION_FIELDS,
     as_json: bool = False,
 ) -> Sequence[dict[str, Any]]:
-    """List a task's annotation sessions, with how much each annotated and
-    whether it was disabled"""
+    """List a task's annotation sessions, with how much each annotated, how
+    much of that the dataset still holds, and whether it was excluded"""
     auth = get_auth_state()
     task = resolve_task(name_or_id, cluster_id=cluster_id, project_id=project_id)
     dataset = auth.client.task.dataset(task.id)
     summary = auth.broker_client.datasets.session_counts(dataset.name)
     removed = set(summary.removed or [])
     rows = []
+    counts = summary.counts or {}
     for session in auth.client.session.all(task_id=task.id):
         name = _sitting_name(dataset.name, task.id, session.annotator_id, session.id)
+        count = counts.get(name)
         rows.append(
             {
                 "id": str(session.id),
                 "annotator": session.annotator_name,
                 "started": session.created.isoformat(timespec="seconds"),
-                "annotations": (summary.counts or {}).get(name, 0),
-                "status": "disabled" if name in removed else "active",
+                "annotated": count.annotated if count else 0,
+                "active": count.active if count else 0,
+                "status": "excluded" if name in removed else "active",
             }
         )
     print_table_with_select(rows, select=select, as_json=as_json)
     return rows
 
 
-def _set_session_disabled(
-    session_id: UUID, disabled: bool, as_json: bool
+def _set_session_excluded(
+    session_id: UUID, excluded: bool, as_json: bool
 ) -> dict[str, Any]:
     auth = get_auth_state()
     session = auth.client.session.read(id=session_id)
@@ -80,11 +83,11 @@ def _set_session_disabled(
     datasets = auth.broker_client.datasets
     change = (
         datasets.remove_session(dataset.name, name)
-        if disabled
+        if excluded
         else datasets.restore_session(dataset.name, name)
     )
     result = {"session": str(session_id), "examples": change.examples}
-    message = Messages.T072 if disabled else Messages.T073
+    message = Messages.T072 if excluded else Messages.T073
     print_mutation_result(
         result, message.format(id=session_id, count=change.examples), as_json=as_json
     )
@@ -93,15 +96,15 @@ def _set_session_disabled(
 
 @cli.subcommand(
     "sessions",
-    "disable",
+    "exclude",
     session_id=Arg(help=Messages.session_id),
     as_json=Arg("--json", help=Messages.as_json),
 )
-def disable(session_id: UUID, as_json: bool = False) -> dict[str, Any]:
-    """Disable an annotation session: take its examples out of the task's
+def exclude(session_id: UUID, as_json: bool = False) -> dict[str, Any]:
+    """Exclude an annotation session: take its examples out of the task's
     dataset, so training and exports leave them out and their tasks are served
     again. They still count as the annotator's work"""
-    return _set_session_disabled(session_id, True, as_json)
+    return _set_session_excluded(session_id, True, as_json)
 
 
 @cli.subcommand(
@@ -111,6 +114,6 @@ def disable(session_id: UUID, as_json: bool = False) -> dict[str, Any]:
     as_json=Arg("--json", help=Messages.as_json),
 )
 def activate(session_id: UUID, as_json: bool = False) -> dict[str, Any]:
-    """Activate a disabled annotation session: put its examples back into the
-    task's dataset"""
-    return _set_session_disabled(session_id, False, as_json)
+    """Activate an excluded annotation session: put its examples back into
+    the task's dataset"""
+    return _set_session_excluded(session_id, False, as_json)