Skip to content

Commit

Permalink
Status -> TrainStatus, keys optional
Browse files Browse the repository at this point in the history
  • Loading branch information
apbassett committed Nov 21, 2024
1 parent 1046f7d commit 9ccb0b4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions howso/client/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
Persistence,
Precision,
SeriesIDTracking,
Status,
TrainStatus,
TabularData2D,
TabularData3D,
TargetedModel,
Expand Down Expand Up @@ -495,7 +495,7 @@ def train( # noqa: C901
skip_reduce_data: bool = False,
train_weights_only: bool = False,
validate: bool = True,
) -> Status:
) -> TrainStatus:
"""
Train one or more cases into a Trainee.
Expand Down
10 changes: 5 additions & 5 deletions howso/client/typing.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import annotations

import os
from typing import Any, Literal, Union
from typing import Any, Literal, NotRequired, Union

from pandas import DataFrame
from typing_extensions import Sequence, TypeAlias, TypedDict
Expand Down Expand Up @@ -37,13 +37,13 @@ class Evaluation(TypedDict):
"""A mapping of feature names to lists of values."""


class Status(TypedDict):
"""Representation of a status output from the Howso Engine."""
class TrainStatus(TypedDict):
"""Representation of a status output from AbstractHowsoClient.train."""

needs_analyze: bool
needs_analyze: NotRequired[bool]
"""Indicates whether the Trainee needs an analyze."""

needs_data_reduction: bool
needs_data_reduction: NotRequired[bool]
"""Indicates whether the Trainee recommends a call to `reduce_data`."""


Expand Down

0 comments on commit 9ccb0b4

Please sign in to comment.