Skip to content

🧪 BaselineRegressor

Baseline Regressor.

Get a baseline by fitting data on multiple different models and comparing the best metrics.

Parameters:

Name Type Description Default
extendedSearch Boolean If set to true, an extended set of models will be used to fit the classifier. This might result in significantly higher runtime. false
Stub code in BaselineRegressor.sdsstub

@Experimental
class BaselineRegressor(
    @PythonName("extended_search") extendedSearch: Boolean = false
) {
    /**
     * Whether the model is fitted.
     */
    @PythonName("is_fitted") attr isFitted: Boolean

    /**
     * Train the Regressor with given training data.
     *
     * The original model is not modified.
     *
     * @param trainData The data the network should be trained on.
     *
     * @result trainedClassifier The trained Regressor
     */
    @Pure
    fun fit(
        @PythonName("train_data") trainData: TabularDataset
    ) -> trainedClassifier: BaselineRegressor

    /**
     * Make a prediction for the given test data and calculate the best metrics.
     *
     * The original Model is not modified.
     *
     * @param testData The data the Regressor should predict.
     *
     * @result bestMetrics A dictionary with the best metrics that were achieved.
     */
    @Pure
    fun predict(
        @PythonName("test_data") testData: TabularDataset
    ) -> bestMetrics: Map<String, Float>
}

isFitted

Whether the model is fitted.

Type: Boolean

fit

Train the Regressor with given training data.

The original model is not modified.

Parameters:

Name Type Description Default
trainData TabularDataset The data the network should be trained on. -

Results:

Name Type Description
trainedClassifier BaselineRegressor The trained Regressor
Stub code in BaselineRegressor.sdsstub

@Pure
fun fit(
    @PythonName("train_data") trainData: TabularDataset
) -> trainedClassifier: BaselineRegressor

predict

Make a prediction for the given test data and calculate the best metrics.

The original Model is not modified.

Parameters:

Name Type Description Default
testData TabularDataset The data the Regressor should predict. -

Results:

Name Type Description
bestMetrics Map<String, Float> A dictionary with the best metrics that were achieved.
Stub code in BaselineRegressor.sdsstub

@Pure
fun predict(
    @PythonName("test_data") testData: TabularDataset
) -> bestMetrics: Map<String, Float>