diff --git a/python/ray/air/checkpoint.py b/python/ray/air/checkpoint.py index 2ad931761..d4c86c757 100644 --- a/python/ray/air/checkpoint.py +++ b/python/ray/air/checkpoint.py @@ -38,7 +38,7 @@ _CHECKPOINT_DIR_PREFIX = "checkpoint_tmp_" logger = logging.getLogger(__name__) -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class Checkpoint: """Ray AIR Checkpoint. diff --git a/python/ray/air/config.py b/python/ray/air/config.py index b85ed779d..e380c0661 100644 --- a/python/ray/air/config.py +++ b/python/ray/air/config.py @@ -77,7 +77,7 @@ def _repr_dataclass(obj, *, default_values: Optional[Dict[str, Any]] = None) -> @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class ScalingConfig: """Configuration for scaling training. @@ -264,7 +264,7 @@ class ScalingConfig: @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class DatasetConfig: """Configuration for ingest of a single Dataset. @@ -428,7 +428,7 @@ class DatasetConfig: @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class FailureConfig: """Configuration related to failure handling of each run/trial. @@ -463,7 +463,7 @@ class FailureConfig: @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class CheckpointConfig: """Configurable parameters for defining the checkpointing strategy. @@ -543,7 +543,7 @@ class CheckpointConfig: @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class RunConfig: """Runtime configuration for individual trials that are run. diff --git a/python/ray/air/result.py b/python/ray/air/result.py index 99e176d3b..357bc14d3 100644 --- a/python/ray/air/result.py +++ b/python/ray/air/result.py @@ -9,7 +9,7 @@ import pandas as pd @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class Result: """The final result of a ML training run or a Tune trial. diff --git a/python/ray/data/preprocessor.py b/python/ray/data/preprocessor.py index bd3739e98..568b94c87 100644 --- a/python/ray/data/preprocessor.py +++ b/python/ray/data/preprocessor.py @@ -13,14 +13,14 @@ if TYPE_CHECKING: from ray.air.data_batch_type import DataBatchType -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class PreprocessorNotFittedException(RuntimeError): """Error raised when the preprocessor needs to be fitted first.""" pass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class Preprocessor(abc.ABC): """Implements an ML preprocessing operation. diff --git a/python/ray/train/base_trainer.py b/python/ray/train/base_trainer.py index 19cc86e66..6fb48b165 100644 --- a/python/ray/train/base_trainer.py +++ b/python/ray/train/base_trainer.py @@ -27,7 +27,7 @@ GenDataset = Union["Dataset", Callable[[], "Dataset"]] logger = logging.getLogger(__name__) -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TrainingFailedError(RuntimeError): """An error indicating that training has failed.""" @@ -322,7 +322,7 @@ class BaseTrainer(abc.ABC): """ raise NotImplementedError - @PublicAPI(stability="alpha") + @PublicAPI(stability="beta") def fit(self) -> Result: """Runs training. diff --git a/python/ray/train/batch_predictor.py b/python/ray/train/batch_predictor.py index 90d0c4afd..3361335c3 100644 --- a/python/ray/train/batch_predictor.py +++ b/python/ray/train/batch_predictor.py @@ -12,7 +12,7 @@ from ray.train.predictor import Predictor from ray.util.annotations import PublicAPI -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class BatchPredictor: """Batch predictor class. diff --git a/python/ray/train/horovod/horovod_trainer.py b/python/ray/train/horovod/horovod_trainer.py index 48a3df1dd..da0e2c70a 100644 --- a/python/ray/train/horovod/horovod_trainer.py +++ b/python/ray/train/horovod/horovod_trainer.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class HorovodTrainer(DataParallelTrainer): """A Trainer for data parallel Horovod training. diff --git a/python/ray/train/lightgbm/lightgbm_checkpoint.py b/python/ray/train/lightgbm/lightgbm_checkpoint.py index d18ffb43e..8b6eb708d 100644 --- a/python/ray/train/lightgbm/lightgbm_checkpoint.py +++ b/python/ray/train/lightgbm/lightgbm_checkpoint.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class LightGBMCheckpoint(Checkpoint): """A :py:class:`~ray.air.checkpoint.Checkpoint` with LightGBM-specific functionality. diff --git a/python/ray/train/lightgbm/lightgbm_predictor.py b/python/ray/train/lightgbm/lightgbm_predictor.py index a94651a60..478966a3b 100644 --- a/python/ray/train/lightgbm/lightgbm_predictor.py +++ b/python/ray/train/lightgbm/lightgbm_predictor.py @@ -15,7 +15,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class LightGBMPredictor(Predictor): """A predictor for LightGBM models. diff --git a/python/ray/train/lightgbm/lightgbm_trainer.py b/python/ray/train/lightgbm/lightgbm_trainer.py index 30e4f4c69..d018a4d59 100644 --- a/python/ray/train/lightgbm/lightgbm_trainer.py +++ b/python/ray/train/lightgbm/lightgbm_trainer.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class LightGBMTrainer(GBDTTrainer): """A Trainer for data parallel LightGBM training. diff --git a/python/ray/train/predictor.py b/python/ray/train/predictor.py index 64e74bbe6..53bec48b6 100644 --- a/python/ray/train/predictor.py +++ b/python/ray/train/predictor.py @@ -29,14 +29,14 @@ TYPE_TO_ENUM: Dict[Type[DataBatchType], DataType] = { } -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class PredictorNotSerializableException(RuntimeError): """Error raised when trying to serialize a Predictor instance.""" pass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class Predictor(abc.ABC): """Predictors load models from checkpoints to perform inference. diff --git a/python/ray/train/tensorflow/tensorflow_checkpoint.py b/python/ray/train/tensorflow/tensorflow_checkpoint.py index 213fad0a2..2fc10ba4f 100644 --- a/python/ray/train/tensorflow/tensorflow_checkpoint.py +++ b/python/ray/train/tensorflow/tensorflow_checkpoint.py @@ -12,7 +12,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TensorflowCheckpoint(Checkpoint): """A :py:class:`~ray.air.checkpoint.Checkpoint` with TensorFlow-specific functionality. diff --git a/python/ray/train/tensorflow/tensorflow_predictor.py b/python/ray/train/tensorflow/tensorflow_predictor.py index 98f33a59a..01149d642 100644 --- a/python/ray/train/tensorflow/tensorflow_predictor.py +++ b/python/ray/train/tensorflow/tensorflow_predictor.py @@ -19,7 +19,7 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TensorflowPredictor(DLPredictor): """A predictor for TensorFlow models. diff --git a/python/ray/train/tensorflow/tensorflow_trainer.py b/python/ray/train/tensorflow/tensorflow_trainer.py index b097c6852..bcf1453a3 100644 --- a/python/ray/train/tensorflow/tensorflow_trainer.py +++ b/python/ray/train/tensorflow/tensorflow_trainer.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TensorflowTrainer(DataParallelTrainer): """A Trainer for data parallel Tensorflow training. diff --git a/python/ray/train/torch/torch_checkpoint.py b/python/ray/train/torch/torch_checkpoint.py index 3005381c2..b3d495bd5 100644 --- a/python/ray/train/torch/torch_checkpoint.py +++ b/python/ray/train/torch/torch_checkpoint.py @@ -12,7 +12,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TorchCheckpoint(Checkpoint): """A :py:class:`~ray.air.checkpoint.Checkpoint` with Torch-specific functionality. diff --git a/python/ray/train/torch/torch_predictor.py b/python/ray/train/torch/torch_predictor.py index 57d3c4990..ee7a3d89e 100644 --- a/python/ray/train/torch/torch_predictor.py +++ b/python/ray/train/torch/torch_predictor.py @@ -18,7 +18,7 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TorchPredictor(DLPredictor): """A predictor for PyTorch models. diff --git a/python/ray/train/torch/torch_trainer.py b/python/ray/train/torch/torch_trainer.py index 38456d535..8c02844b9 100644 --- a/python/ray/train/torch/torch_trainer.py +++ b/python/ray/train/torch/torch_trainer.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TorchTrainer(DataParallelTrainer): """A Trainer for data parallel PyTorch training. diff --git a/python/ray/train/xgboost/xgboost_checkpoint.py b/python/ray/train/xgboost/xgboost_checkpoint.py index 362f87849..b803a5b03 100644 --- a/python/ray/train/xgboost/xgboost_checkpoint.py +++ b/python/ray/train/xgboost/xgboost_checkpoint.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class XGBoostCheckpoint(Checkpoint): """A :py:class:`~ray.air.checkpoint.Checkpoint` with XGBoost-specific functionality. diff --git a/python/ray/train/xgboost/xgboost_predictor.py b/python/ray/train/xgboost/xgboost_predictor.py index c68e5606b..aa8f9d2a9 100644 --- a/python/ray/train/xgboost/xgboost_predictor.py +++ b/python/ray/train/xgboost/xgboost_predictor.py @@ -14,7 +14,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class XGBoostPredictor(Predictor): """A predictor for XGBoost models. diff --git a/python/ray/train/xgboost/xgboost_trainer.py b/python/ray/train/xgboost/xgboost_trainer.py index 1fe14e001..61ce02f33 100644 --- a/python/ray/train/xgboost/xgboost_trainer.py +++ b/python/ray/train/xgboost/xgboost_trainer.py @@ -13,7 +13,7 @@ if TYPE_CHECKING: from ray.data.preprocessor import Preprocessor -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class XGBoostTrainer(GBDTTrainer): """A Trainer for data parallel XGBoost training. diff --git a/python/ray/tune/search/variant_generator.py b/python/ray/tune/search/variant_generator.py index 4491a7b5e..5fb79d2a1 100644 --- a/python/ray/tune/search/variant_generator.py +++ b/python/ray/tune/search/variant_generator.py @@ -58,7 +58,7 @@ def generate_variants( yield resolved_vars, spec -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") def grid_search(values: Iterable) -> Dict[str, List]: """Convenience method for specifying grid search over a value. diff --git a/python/ray/tune/tune_config.py b/python/ray/tune/tune_config.py index dbb9861ab..96558f467 100644 --- a/python/ray/tune/tune_config.py +++ b/python/ray/tune/tune_config.py @@ -8,7 +8,7 @@ from ray.util import PublicAPI @dataclass -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class TuneConfig: """Tune specific configs. diff --git a/python/ray/tune/tuner.py b/python/ray/tune/tuner.py index 6c72529bd..49c4f5eb6 100644 --- a/python/ray/tune/tuner.py +++ b/python/ray/tune/tuner.py @@ -28,7 +28,7 @@ _TUNER_INTERNAL = "_tuner_internal" _SELF = "self" -@PublicAPI(stability="alpha") +@PublicAPI(stability="beta") class Tuner: """Tuner is the recommended way of launching hyperparameter tuning jobs with Ray Tune.