Class DocumentCategorizerEventStream

Namespace

NOpenNLP.Tools.Doccat

Assembly

NOpenNLP.Tools.dll

Iterator-like class for modeling document classification events.

public class DocumentCategorizerEventStream : AbstractEventStream<DocumentSample>, IObjectStream<Event?>, IDisposable

Inheritance

object

ObjectStreamBase<Event>

AbstractEventStream<DocumentSample>

DocumentCategorizerEventStream

Implements

IObjectStream<Event>

IDisposable

Inherited Members

AbstractEventStream<DocumentSample>.Read()

AbstractEventStream<DocumentSample>.Reset()

AbstractEventStream<DocumentSample>.Dispose(bool)

ObjectStreamBase<Event>.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentCategorizerEventStream(IObjectStream<DocumentSample?>)

Initializes the current instance.

public DocumentCategorizerEventStream(IObjectStream<DocumentSample?> samples)

Parameters

samples IObjectStream<DocumentSample>

IObjectStream<T> of DocumentSamples

DocumentCategorizerEventStream(IObjectStream<DocumentSample?>, params IFeatureGenerator[])

Initializes the current instance via samples and feature generators.

public DocumentCategorizerEventStream(IObjectStream<DocumentSample?> data, params IFeatureGenerator[] featureGenerators)

Parameters

data IObjectStream<DocumentSample>

IObjectStream<T> of DocumentSamples

featureGenerators IFeatureGenerator[]

the feature generators

Methods

CreateEvents(DocumentSample)

Creates events for the provided sample.

protected override IEnumerable<Event> CreateEvents(DocumentSample sample)

Parameters

sample DocumentSample

the sample for which training Events are be created.

Returns

IEnumerable<Event>

a sequence of training events, or an empty sequence.

Remarks

NOpenNLP: upstream returns an Iterator<Event>. This returns IEnumerable<T> instead, which is the more usual .NET shape and spares implementers from handing back an enumerator the caller must dispose. Read() enumerates it manually, since it yields one event per call.