# `MOAStream`

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

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

A datastream that can be learnt instance by instance.

#### \_\_init_\_(moa_stream: InstanceStream | [None](https://docs.python.org/3/builtins/constants.html#None) = None, schema: [Schema](capymoa.stream.Schema.md#capymoa.stream.Schema) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, CLI: [str](https://docs.python.org/3/builtins/stdtypes.html#str) | [None](https://docs.python.org/3/builtins/constants.html#None) = None)[[source]](https://github.com/adaptive-machine-learning/CapyMOA/blob/3e255b1/src/capymoa/stream/_stream.py#L421)

Construct a Stream from a MOA stream object.

Usually, you will want to construct a Stream using [`ARFFStream`](capymoa.stream.ARFFStream.md#capymoa.stream.ARFFStream),
[`NumpyStream`](capymoa.stream.NumpyStream.md#capymoa.stream.NumpyStream), or [`CSVStream`](capymoa.stream.CSVStream.md#capymoa.stream.CSVStream).

* **Parameters:**
  * **moa_stream** – The MOA stream object to read instances from. Is None
    if the stream is created from a numpy array.
  * **schema** – The schema of the stream. If None, the schema is inferred
    from the moa_stream.
  * **CLI** – Additional command line arguments to pass to the MOA stream.
* **Raises:**
  * [**ValueError**](https://docs.python.org/3/builtins/exceptions.html#ValueError) – If no schema is provided and no moa_stream is provided.
  * [**ValueError**](https://docs.python.org/3/builtins/exceptions.html#ValueError) – If command line arguments are provided without a moa_stream.

#### \_\_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.MOAStream.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.
