# `HyperPlaneRegression`

### *class* capymoa.stream.generator.HyperPlaneRegression[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/generator.py#L306)

Bases: [`MOAStream`](capymoa.stream.MOAStream.md#capymoa.stream.MOAStream)

Generates HyperPlane Regression concepts functions.

```pycon
>>> from capymoa.stream.generator import HyperPlaneRegression
...
>>> stream = HyperPlaneRegression()
>>> stream.next_instance()
RegressionInstance(
    Schema(generators.HyperplaneGeneratorForRegression ),
    x=[0.397 0.348 0.294 0.506 0.116 0.771 0.66  0.157 0.378 0.14 ],
    y_value=205.17965508540908
)
>>> stream.next_instance().x
array([0.00485253, 0.85225356, 0.02341807, 0.70500995, 0.27502995,
       0.0753878 , 0.61059154, 0.95493077, 0.2740691 , 0.19020221])
```

#### \_\_init_\_(instance_random_seed: [int](https://docs.python.org/3/builtins/functions.html#int) = 1, number_of_classes: [int](https://docs.python.org/3/builtins/functions.html#int) = 2, number_of_attributes: [int](https://docs.python.org/3/builtins/functions.html#int) = 10, number_of_drifting_attributes: [int](https://docs.python.org/3/builtins/functions.html#int) = 2, magnitude_of_change: [float](https://docs.python.org/3/builtins/functions.html#float) = 0.0, noise_percentage: [int](https://docs.python.org/3/builtins/functions.html#int) = 5, sigma_percentage: [int](https://docs.python.org/3/builtins/functions.html#int) = 10)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/generator.py#L323)

Construct a HyperPlane Regression datastream generator.

* **Parameters:**
  * **instance_random_seed** – Seed for random generation of instances, defaults to 1
  * **number_of_classes** – The number of classes of the generated instances, defaults to 2
  * **number_of_attributes** – The number of attributes of the generated instances, defaults to 10
  * **number_of_drifting_attributes** – The number of drifting attributes, defaults to 2
  * **magnitude_of_change** – Magnitude of change in the generated instances, defaults to 0.0
  * **noise_percentage** – Percentage of noise to add to the data, defaults to 10
  * **sigma_percentage** – Percentage of sigma to add to the data, defaults to 10

#### \_\_iter_\_() → [Self](https://docs.python.org/3/library/typing.html#typing.Self)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L356)

Get an iterator over the stream.

This will NOT restart the stream if it has already been iterated over.
Please use the [`restart()`](#capymoa.stream.generator.HyperPlaneRegression.restart) method to restart the stream.

* **Yield:**
  An iterator over the stream.

#### \_\_next_\_() → \_AnyInstance[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L366)

Get the next instance in the stream.

* **Returns:**
  The next instance in the stream.

#### cli_help() → [str](https://docs.python.org/3/builtins/stdtypes.html#str)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L466)

Return cli help string for the stream.

#### get_moa_stream() → InstanceStream | [None](https://docs.python.org/3/builtins/constants.html#None)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L502)

Get the MOA stream object if it exists.

#### get_schema() → [Schema](capymoa.stream.Schema.md#capymoa.stream.Schema)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L498)

Return the schema of the stream.

#### has_more_instances() → [bool](https://docs.python.org/3/builtins/functions.html#bool)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L474)

Return True if the stream have more instances to read.

#### next_instance() → \_AnyInstance[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L478)

Return the next instance in the stream.

* **Raises:**
  [**ValueError**](https://docs.python.org/3/builtins/exceptions.html#ValueError) – If the machine learning task is neither a regression
  nor a classification task.
* **Returns:**
  A labeled instances or a regression depending on the schema.

#### restart()[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L506)

Restart the stream to read instances from the beginning.