Index

A B C D E F G H I K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accentBlue() - Method in interface org.coordinatekit.crf.cli.Banner.Product
The blue component of the accent color, 0-255.
accentGreen() - Method in interface org.coordinatekit.crf.cli.Banner.Product
The green component of the accent color, 0-255.
accentRed() - Method in interface org.coordinatekit.crf.cli.Banner.Product
The red component of the accent color, 0-255.
ACCEPT - Enum constant in enum class org.coordinatekit.crf.annotator.TaggingAction
The user accepted the sequence's tags (possibly after editing).
action() - Method in interface org.coordinatekit.crf.annotator.TaggingResult
Returns the action chosen by the user.
align(int, TrainingSequence<T>) - Method in class org.coordinatekit.crf.core.align.AlignmentDetector
Aligns a single stored sequence against the tokenizer.
aligned() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
Returns the number of AlignmentStatus.ALIGNED sequences.
aligned() - Method in interface org.coordinatekit.crf.core.align.TokenComparison
Returns whether the two token lists are identical.
ALIGNED - Enum constant in enum class org.coordinatekit.crf.core.align.AlignmentStatus
Re-tokenizing the surface reproduced the stored token list exactly.
AlignmentDetector<T> - Class in org.coordinatekit.crf.core.align
Detects training sequences that no longer align with a tokenizer.
AlignmentDetector(Tokenizer, TrainingDataSequencer<T>) - Constructor for class org.coordinatekit.crf.core.align.AlignmentDetector
Constructs a detector over the given tokenizer and sequencer, using the exact-match strategy.
AlignmentDetector(Tokenizer, TrainingDataSequencer<T>, AlignmentStrategy) - Constructor for class org.coordinatekit.crf.core.align.AlignmentDetector
Constructs a detector over the given tokenizer, sequencer, and comparison strategy.
AlignmentModels - Class in org.coordinatekit.crf.core.align
Factory for the public value types and the default strategy in the align package.
AlignmentReport<T> - Interface in org.coordinatekit.crf.core.align
The alignment results for a single training data file.
AlignmentStatus - Enum Class in org.coordinatekit.crf.core.align
The outcome of comparing a stored training sequence against a tokenizer's re-tokenization of its surface.
alignmentStrategy(AlignmentStrategy) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the strategy used to compare a stored token list against the re-tokenized surface when deciding whether a sequence is aligned.
AlignmentStrategy - Interface in org.coordinatekit.crf.core.align
Compares a stored token list against a re-tokenized one and reports how they diverge.
AlignmentSummary - Class in org.coordinatekit.crf.core.align
A per-status tally of a training data file's sequence alignments.
allAligned() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
Returns whether every sequence in the file is aligned.
alternativeTagScores() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the map from tag to score for the edit screen, in canonical iteration order: tags with a non-null score first (sorted by score descending), then tags with a null score, with the natural tag order breaking ties.
AmbiguousServiceException - Exception Class in org.coordinatekit.crf.core.spi
Thrown when more than one provider of a service type is registered and none was supplied explicitly.
AmbiguousServiceException(Class<?>, List<?>) - Constructor for exception class org.coordinatekit.crf.core.spi.AmbiguousServiceException
Constructs an exception naming the ambiguous service and its registered implementations.
annotate(Path, Path) - Method in class org.coordinatekit.crf.annotator.Annotator
Annotates the input file, appending accepted sequences to the output file.
Annotator<F,T> - Class in org.coordinatekit.crf.annotator
Orchestrates an interactive annotation session over an input file of one-sequence-per-line text.
Annotator.Builder<F,T> - Class in org.coordinatekit.crf.annotator
Builder for Annotator.
AnnotatorConfiguration - Class in org.coordinatekit.crf.annotator
Parser-free inputs for AnnotatorRunner.
AnnotatorConfiguration.Builder - Class in org.coordinatekit.crf.annotator
Builder for constructing AnnotatorConfiguration instances.
AnnotatorModels - Class in org.coordinatekit.crf.annotator
Factory for the public value types in the ui package.
AnnotatorRunner - Class in org.coordinatekit.crf.annotator
Parser-free invocation of the annotate flow.
AnnotatorRunner.AnnotatorFactory - Interface in org.coordinatekit.crf.annotator
Factory that wires the typed beans (tag provider, tokenizer, feature extractor, optional CRF tagger) into an Annotator.
annotatorSequence(int, int, List<String>, TagProvider<T>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates an AnnotatorSequence for the no-tagger path, with no display features.
annotatorSequence(int, int, List<String>, TagProvider<T>, List<Set<F>>, List<Set<F>>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates an AnnotatorSequence for the no-tagger path, where the user will choose tags from scratch, with optional display features.
annotatorSequence(int, int, Sequence<TaggedPositionedToken<F, T>>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates an AnnotatorSequence from a tagger's output, with no display features.
annotatorSequence(int, int, Sequence<TaggedPositionedToken<F, T>>, List<Set<F>>, List<Set<F>>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates an AnnotatorSequence from a tagger's output, with optional display features and no probability function.
annotatorSequence(int, int, Sequence<TaggedPositionedToken<F, T>>, List<Set<F>>, List<Set<F>>, ToDoubleFunction<List<T>>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates an AnnotatorSequence from a tagger's output, with optional display features and an optional probability function.
AnnotatorSequence<F,T> - Interface in org.coordinatekit.crf.annotator
A view-model describing a single sequence to present to a user for tagging.
AnnotatorToken<F,T> - Interface in org.coordinatekit.crf.annotator
A view-model entry for a single token within an AnnotatorSequence.
appendingWriter(Path) - Method in interface org.coordinatekit.crf.core.io.TrainingDataAppender
Opens a training sequence writer that appends to the given file.
appendingWriter(Path) - Method in class org.coordinatekit.crf.core.io.XmlTrainingData
Opens a training sequence writer that appends to the given file.
apply(F, int) - Method in interface org.coordinatekit.crf.core.preprocessing.WindowFeatureMapper
Applies this mapper to transform a feature based on its relative position.
availableNames() - Method in exception class org.coordinatekit.crf.core.spi.UnknownServiceException
Returns the names of the registered providers of the service type, sorted.

B

Banner - Class in org.coordinatekit.crf.cli
Renders the CoordinateKit brand art — the globe "mark" stacked above a figlet-style word banner — as the header section of a tool's root usage message.
Banner(Banner.Product) - Constructor for class org.coordinatekit.crf.cli.Banner
Creates a banner for product.
Banner.Product - Interface in org.coordinatekit.crf.cli
A tool's product identity: the wordmark art in two sizes plus the accent color its name is painted in.
bigArt() - Method in interface org.coordinatekit.crf.cli.Banner.Product
The large wordmark art, one string per row.
BOTH - Enum constant in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Both key and verbose display features are available.
build() - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Builds the annotator.
build() - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration.Builder
Builds the configuration with the current settings.
build() - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration.Builder
Builds the configuration with the current settings.
build() - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Builds the reviewer.
build() - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface.Builder
Builds the interface.
build() - Method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration.Builder
Builds the configuration with the current settings.
build() - Method in class org.coordinatekit.crf.core.preprocessing.LengthFeatureExtractor.Builder
Builds the feature extractor.
build() - Method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor.Builder
Builds the feature extractor.
build() - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor.Builder
Builds the feature extractor.
build() - Method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor.Builder
Builds the feature extractor.
build() - Method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor.Builder
Builds a new WindowFeatureExtractor with the configured parameters.
build() - Method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor.Builder
Builds the feature extractor.
build() - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Builds the configuration with the current settings.
build() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Builds the configuration with the current settings.
build() - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration.Builder
Builds the configuration with the current settings.
builder() - Static method in class org.coordinatekit.crf.annotator.Annotator
Returns a new builder for Annotator.
builder() - Static method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
Returns a new AnnotatorConfiguration.Builder instance for constructing a configuration.
builder() - Static method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
Returns a new RetokenizeConfiguration.Builder instance for constructing a configuration.
builder() - Static method in class org.coordinatekit.crf.annotator.RetokenizeReviewer
Returns a new builder for RetokenizeReviewer.
builder() - Static method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface
Returns a new builder for TerminalTaggingInterface.
builder() - Static method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration
Returns a new XmlTrainingDataConfiguration.Builder instance for constructing a configuration.
builder() - Static method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor
Creates a new builder for PositionFeatureExtractor.
builder() - Static method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns a new ConllOutputConfiguration.Builder instance for constructing a configuration.
builder() - Static method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns a new MalletCrfTrainerConfiguration.Builder instance for constructing a configuration.
builder() - Static method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns a new ModelOutputConfiguration.Builder instance for constructing a configuration.
builder(int) - Static method in class org.coordinatekit.crf.core.preprocessing.LengthFeatureExtractor
Creates a new builder with the specified length upper limit.
builder(InputStream, String) - Static method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor
Creates a new builder with the specified XML input stream and XPath expression.
builder(String) - Static method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor
Creates a new builder with the specified pattern string.
builder(String, boolean) - Static method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor
Creates a new builder with the specified pattern string and case sensitivity.
builder(Function<String, F>) - Static method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor
Creates a new builder with the specified feature mapper function.
builder(Pattern) - Static method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor
Creates a new builder with the specified compiled pattern.
builder(FeatureExtractor<F>, WindowFeatureMapper<F>) - Static method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor
Creates a new builder for constructing a WindowFeatureExtractor.

C

caseSensitive(boolean) - Method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor.Builder
Sets whether token matching should be case-sensitive.
close() - Method in interface org.coordinatekit.crf.core.io.TrainingSequenceWriter
Finalizes the output and releases any underlying resources.
compare(List<String>, List<String>) - Method in interface org.coordinatekit.crf.core.align.AlignmentStrategy
Compares the two token lists and returns their divergences.
comparison() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the comparison of the stored and re-tokenized token lists.
CompositeFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that combines multiple feature extractors into one.
CompositeTestAccuracyEvaluator - Class in org.coordinatekit.crf.mallet.train
A composite evaluator that logs iteration statistics along with both instance and token accuracy metrics on test data.
CompositeTestAccuracyEvaluator(InstanceList, String) - Constructor for class org.coordinatekit.crf.mallet.train.CompositeTestAccuracyEvaluator
Creates a new composite evaluator for the specified test data.
configuration - Variable in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
The configuration parameters controlling the training process.
Configuration Options - Search tag in package org.coordinatekit.crf.mallet.train
Section
conllOutputConfiguration() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the configuration for CoNLL output.
conllOutputConfiguration(ConllOutputConfiguration) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the configuration for CoNLL output.
ConllOutputConfiguration - Class in org.coordinatekit.crf.mallet.train
Configuration settings for ConllOutputEvaluator.
ConllOutputConfiguration.Builder - Class in org.coordinatekit.crf.mallet.train
Builder for constructing ConllOutputConfiguration instances.
conllOutputEnabled() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns whether CoNLL output is enabled during training.
conllOutputEnabled(boolean) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets whether to enable CoNLL output during training.
ConllOutputEvaluator - Class in org.coordinatekit.crf.mallet.train
An evaluator that outputs predicted and actual labels in CoNLL format.
ConllOutputEvaluator(InstanceList, String, ConllOutputConfiguration) - Constructor for class org.coordinatekit.crf.mallet.train.ConllOutputEvaluator
Creates a new CoNLL output evaluator with the specified configuration.
create(AnnotatorConfiguration, Terminal) - Method in interface org.coordinatekit.crf.annotator.AnnotatorRunner.AnnotatorFactory
Constructs an annotator from the configuration and the JLine terminal opened by the runner.
create(RetokenizeConfiguration, Terminal) - Method in interface org.coordinatekit.crf.annotator.RetokenizeRunner.ReviewerFactory
Constructs a reviewer from the configuration and the JLine terminal opened by the runner.
createCrf(InstanceList) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Creates a CRF model initialized with states derived from the training data.
createCrfTrainer(CRF) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Creates and configures a threaded CRF trainer for the given model.
CRF_SCHEMA_NAMESPACE_URI - Static variable in class org.coordinatekit.crf.core.io.XmlTrainingData
The namespace URI for CRF structural elements.
CrfLauncher - Class in org.coordinatekit.crf.cli
The entry point for the crf command-line tool.
CrfServices - Class in org.coordinatekit.crf.core.spi
Discovers the CRF domain SPIs, applying each slot's canonical default.
CrfTagger<F,T> - Interface in org.coordinatekit.crf.core.tag
A conditional random field (CRF) tagger that assigns tags to tokens in an input string.
CrfTaggerLoader - Interface in org.coordinatekit.crf.core.tag
Loads a CrfTagger from a serialized model on disk, given the beans the tagger needs at construction time.
CrfTrainer - Interface in org.coordinatekit.crf.core.train
Interface for training Conditional Random Field (CRF) models.

D

decode(String) - Method in class org.coordinatekit.crf.core.StringTagProvider
 
decode(String) - Method in interface org.coordinatekit.crf.core.TagProvider
Converts a string representation to a typed tag value.
DEFAULT_ROOT_ELEMENT_NAME - Static variable in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration
The default local name used for the root element of training data documents written by XmlTrainingData.
DEFAULT_THRESHOLD - Static variable in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
The default highlighting threshold used when none is set on the AnnotatorConfiguration.Builder.
DEFAULT_THRESHOLD - Static variable in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
The default highlighting threshold used when none is set on the RetokenizeConfiguration.Builder.
DEFAULT_THRESHOLD_TEXT - Static variable in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
The AnnotatorConfiguration.DEFAULT_THRESHOLD as a compile-time String for picocli's @Option(defaultValue = ...), which requires a constant expression.
DEFAULT_THRESHOLD_TEXT - Static variable in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
The RetokenizeConfiguration.DEFAULT_THRESHOLD as a compile-time String for picocli's @Option(defaultValue = ...), which requires a constant expression.
defaults() - Static method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration
Returns a configuration with all default values.
defaults() - Static method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns a configuration with all default values.
defaults() - Static method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns a configuration with all default values.
defaults() - Static method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns a configuration with all default values.
DELETION - Enum constant in enum class org.coordinatekit.crf.core.align.DifferenceKind
A run of stored tokens the re-tokenization dropped; its re-tokenized span is empty.
DENSE - Enum constant in enum class org.coordinatekit.crf.mallet.train.WeightsType
Use dense weight storage for all features.
deserialize(Class<T>, Path) - Static method in class org.coordinatekit.crf.core.util.Serializables
Deserializes an object from a file without an ObjectInputFilter.
deserialize(Class<T>, Path, ObjectInputFilter) - Static method in class org.coordinatekit.crf.core.util.Serializables
Deserializes an object from a file, applying the supplied JEP-290 ObjectInputFilter.
detectMaterialized(Path) - Method in class org.coordinatekit.crf.core.align.AlignmentDetector
Builds an in-memory MaterializedAlignmentReport over a training data file.
detectStreaming(Path) - Method in class org.coordinatekit.crf.core.align.AlignmentDetector
Builds a lazy StreamingAlignmentReport over a training data file.
DifferenceKind - Enum Class in org.coordinatekit.crf.core.align
The kind of a single TokenDifference region between a stored token list and a re-tokenized one.
differences() - Method in interface org.coordinatekit.crf.core.align.TokenComparison
Returns the divergent regions between the stored and re-tokenized token lists, in order.

E

encode(String) - Method in class org.coordinatekit.crf.core.StringTagProvider
 
encode(T) - Method in interface org.coordinatekit.crf.core.TagProvider
Converts a typed tag value to its string representation.
ending(boolean) - Method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor.Builder
Sets whether to extract from the end (suffix) or beginning (prefix) of the token.
equals(Object) - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
 
equals(Object) - Method in record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Indicates whether some other object is "equal to" this one.
evaluate(TransducerTrainer) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputEvaluator
 
evaluateInstanceList(TransducerTrainer, InstanceList, String) - Method in class org.coordinatekit.crf.mallet.train.CompositeTestAccuracyEvaluator
 
evaluateInstanceList(TransducerTrainer, InstanceList, String) - Method in class org.coordinatekit.crf.mallet.train.ConllOutputEvaluator
 
evaluateInstanceList(TransducerTrainer, InstanceList, String) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputEvaluator
 
exactMatchStrategy() - Static method in class org.coordinatekit.crf.core.align.AlignmentModels
Returns the default exact-match strategy.
Example: Combining Feature Extractors - Search tag in package org.coordinatekit.crf.core.preprocessing
Section
Example Usage - Search tag in package org.coordinatekit.crf.mallet.tag
Section
Example Usage - Search tag in package org.coordinatekit.crf.mallet.train
Section
excluded(String) - Static method in class org.coordinatekit.crf.core.preprocessing.Segments
Creates an EXCLUDED segment carrying a dropped run of characters.
excluded(String) - Static method in class org.coordinatekit.crf.core.preprocessing.TrainingSegments
Creates an EXCLUDED segment carrying a dropped run of characters.
EXCLUDED - Enum constant in enum class org.coordinatekit.crf.core.preprocessing.SegmentKind
A run of characters a tokenizer dropped; it carries text but no tag.
EXCLUDED_ELEMENT_NAME - Static variable in class org.coordinatekit.crf.core.io.XmlTrainingData
The local name of the element that wraps a run of excluded characters dropped by a tokenizer.
EXIT - Enum constant in enum class org.coordinatekit.crf.annotator.TaggingAction
The user chose to exit the tagging session entirely.
extract(Sequence<? extends PositionedToken>) - Method in interface org.coordinatekit.crf.core.preprocessing.FeatureExtractor
Extracts features for all tokens in a sequence.
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.CompositeFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in interface org.coordinatekit.crf.core.preprocessing.FeatureExtractor
Extracts features for the token at the specified position within a sequence.
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.LengthFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.TransformingFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor
 
extractAt(Sequence<? extends PositionedToken>, int) - Method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor
 
extractTraining(Sequence<? extends TrainingPositionedToken<T>>) - Method in interface org.coordinatekit.crf.core.preprocessing.FeatureExtractor
Extracts features for all tokens in a training sequence, preserving tag information.

F

failureReason() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the reason the tokenizer rejected the surface.
featureAvailability() - Method in interface org.coordinatekit.crf.annotator.AnnotatorSequence
Returns which display-feature sources this sequence carries, derived from which feature extractors were configured.
FeatureAvailability - Enum Class in org.coordinatekit.crf.annotator
Which display-feature sources an AnnotatorSequence carries: the four reachable combinations of key features and verbose features.
featureExtractor - Variable in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
The feature extractor for converting tokens to feature sets during training.
featureExtractor(FeatureExtractor<F>) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the feature extractor used to compute the key display features shown by the feature view of the tagging interface.
featureExtractor(FeatureExtractor<F>) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the feature extractor used to compute the key display features shown by the feature view of the tagging interface.
FeatureExtractor<F> - Interface in org.coordinatekit.crf.core.preprocessing
Extracts features from tokens within a sequence for use in CRF model training and tagging.
Feature Extractors - Search tag in package org.coordinatekit.crf.core.preprocessing
Section
FeaturePositionedToken<F> - Interface in org.coordinatekit.crf.core.preprocessing
A positioned token that includes extracted features.
features() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the key display features for this token, produced by the display feature extractor configured on the annotator.
features() - Method in interface org.coordinatekit.crf.core.preprocessing.FeaturePositionedToken
Returns the set of features extracted for this token.
FeatureSequence<F> - Class in org.coordinatekit.crf.core.preprocessing
A sequence of tokens with extracted features.
FeatureSequence(List<String>, List<Set<F>>) - Constructor for class org.coordinatekit.crf.core.preprocessing.FeatureSequence
Constructs a new feature sequence from the given tokens and features.
FeatureTrainingPositionedToken<F,T> - Interface in org.coordinatekit.crf.core.preprocessing
A positioned token that includes both extracted features and a training label.
FeatureTrainingSequence<F,T> - Class in org.coordinatekit.crf.core.preprocessing
A sequence of tokens with both extracted features and training labels.
FeatureTrainingSequence(List<String>, List<T>, List<Set<F>>) - Constructor for class org.coordinatekit.crf.core.preprocessing.FeatureTrainingSequence
Constructs a new feature training sequence from the given tokens, tags, and features.
filePrefix() - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns the prefix for output file names.
filePrefix() - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns the prefix for output file names.
filePrefix(String) - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Sets the prefix for output file names.
filePrefix(String) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration.Builder
Sets the prefix for output file names.
fileSuffix() - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns the suffix (extension) for output file names.
fileSuffix() - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns the suffix (extension) for output file names.
fileSuffix(String) - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Sets the suffix (extension) for output file names.
fileSuffix(String) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration.Builder
Sets the suffix (extension) for output file names.
finalTags() - Method in interface org.coordinatekit.crf.annotator.TaggingResult
Returns the per-token tags chosen by the user, in the same order as the presented sequence.
firstFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor.Builder
Sets the feature to emit for the first token in a sequence.
flush() - Method in interface org.coordinatekit.crf.core.io.TrainingSequenceWriter
Flushes any buffered output so that previously written sequences are visible to other readers of the same destination.
fromResources(Class<?>, String, String, int, int, int) - Static method in interface org.coordinatekit.crf.cli.Banner.Product
Loads a product from two classpath art resources.
fullFeatureExtractor() - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Discovers the full feature extractor by single registered FullFeatureExtractor > none.
fullFeatureExtractor(FeatureExtractor<F>) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the full feature extractor by explicit > single registered FullFeatureExtractor > none.
FullFeatureExtractor<F> - Interface in org.coordinatekit.crf.core.preprocessing
Marks the feature extractor used for model training and tagging — the full feature set.
fullyConnected() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns whether to create a fully connected CRF state machine.
fullyConnected(boolean) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets whether to create a fully connected CRF state machine.

G

gaussianVariance() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the Gaussian prior variance for L2 regularization.
gaussianVariance(double) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the Gaussian prior variance for L2 regularization.
generateSchema(OutputStream) - Method in interface org.coordinatekit.crf.core.io.TrainingSchemaGenerator
Generates a schema and writes it to the specified output stream.
generateSchema(OutputStream) - Method in class org.coordinatekit.crf.core.io.XmlTrainingData
 
get(int) - Method in class org.coordinatekit.crf.core.InputSequence
 
get(int) - Method in class org.coordinatekit.crf.core.preprocessing.FeatureSequence
 
get(int) - Method in class org.coordinatekit.crf.core.preprocessing.FeatureTrainingSequence
 
get(int) - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
 
get(int) - Method in interface org.coordinatekit.crf.core.Sequence
Returns the token at the specified position in this sequence.
get(int) - Method in class org.coordinatekit.crf.core.tag.TaggedSequence
 

H

hashCode() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
 
hashCode() - Method in record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Returns a hash code value for this object.
hasLengthFeatureMapper(Function<Integer, F>) - Method in class org.coordinatekit.crf.core.preprocessing.LengthFeatureExtractor.Builder
Sets the mapper function to generate features for lengths the sequence has.

I

implementationNames() - Method in exception class org.coordinatekit.crf.core.spi.AmbiguousServiceException
Returns the fully qualified class names of the registered implementations, sorted.
includeCurrentToken(boolean) - Method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor.Builder
Sets whether to include features from the current token.
includeIfLessThanLength(boolean) - Method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor.Builder
Sets whether to include tokens shorter than the configured length.
initialConfidence() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the starting confidence value, or null when no model produced a confidence.
initialTag() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the starting tag shown to the user.
input() - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
Returns the path to the plain-text input file (UTF-8), one sequence per line.
input() - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
Returns the path to the XML training-data file to review.
input() - Method in exception class org.coordinatekit.crf.core.preprocessing.InvalidInputException
Returns the invalid input that caused this exception.
input(Path) - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration.Builder
Sets the path to the plain-text input file (UTF-8), one sequence per line.
input(Path) - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration.Builder
Sets the path to the XML training-data file to review.
InputSequence - Class in org.coordinatekit.crf.core
A sequence of tokens representing user input for tagging.
InputSequence(List<String>) - Constructor for class org.coordinatekit.crf.core.InputSequence
Creates a new sequence from the given list of string tokens.
INSERTION - Enum constant in enum class org.coordinatekit.crf.core.align.DifferenceKind
A run of re-tokenized tokens absent from the stored list; its stored span is empty.
InvalidInputException - Exception Class in org.coordinatekit.crf.core.preprocessing
Exception thrown when input provided to a preprocessing component is invalid.
InvalidInputException(String) - Constructor for exception class org.coordinatekit.crf.core.preprocessing.InvalidInputException
Creates a new exception for invalid input without a specific reason.
InvalidInputException(String, String) - Constructor for exception class org.coordinatekit.crf.core.preprocessing.InvalidInputException
Creates a new exception for invalid input with a specific reason.
isAligned() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns whether this sequence is aligned with the tokenizer.
iterationInterval() - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns the iteration interval for writing output files.
iterationInterval() - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns the iteration interval for writing model files.
iterationInterval(int) - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Sets the iteration interval for writing output files.
iterationInterval(int) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration.Builder
Sets the iteration interval for writing model files.
iterations() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the maximum number of training iterations.
iterations(int) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the maximum number of training iterations.
iterator() - Method in class org.coordinatekit.crf.core.InputSequence
 
iterator() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureSequence
 
iterator() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureTrainingSequence
 
iterator() - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
 
iterator() - Method in class org.coordinatekit.crf.core.tag.TaggedSequence
 

K

KEY_ONLY - Enum constant in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Only key display features are available.
keyAvailable() - Method in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Returns whether key display features are available, enabling the key-feature view.
keyFeatureExtractor() - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Discovers the key feature extractor by single registered KeyFeatureExtractor > none.
keyFeatureExtractor(FeatureExtractor<F>) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the key feature extractor by explicit > single registered KeyFeatureExtractor > none.
KeyFeatureExtractor<F> - Interface in org.coordinatekit.crf.core.preprocessing
Marks the simpler feature extractor that feeds the annotator's key ("key features") view.
kind() - Method in interface org.coordinatekit.crf.core.align.TokenDifference
Returns the kind of this difference.
kind() - Method in interface org.coordinatekit.crf.core.preprocessing.Segment
Returns the kind of this segment.

L

lacksLengthFeatureMapper(Function<Integer, F>) - Method in class org.coordinatekit.crf.core.preprocessing.LengthFeatureExtractor.Builder
Sets the mapper function to generate features for lengths the sequence lacks.
lastFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor.Builder
Sets the feature to emit for the last token in a sequence.
length(int) - Method in class org.coordinatekit.crf.core.preprocessing.SubstringFeatureExtractor.Builder
Sets the length of the substring to extract.
LengthFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that generates features based on the length of a sequence.
LengthFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
load(Path, FeatureExtractor<F>, TagProvider<T>, Tokenizer) - Method in interface org.coordinatekit.crf.core.tag.CrfTaggerLoader
Loads a tagger from the serialized model at modelPath, wiring in the feature extractor, tag provider, and tokenizer it was trained against.
load(Path, FeatureExtractor<F>, TagProvider<T>, Tokenizer) - Method in class org.coordinatekit.crf.mallet.tag.MalletCrfTaggerLoader
 

M

main(String[]) - Static method in class org.coordinatekit.crf.cli.CrfLauncher
Runs the tool and terminates the JVM with the resulting exit code.
MalletCrfTagger<F,T> - Class in org.coordinatekit.crf.mallet.tag
A MALLET-based implementation of CrfTagger that uses a pre-trained CRF model to tag input sequences.
MalletCrfTagger(FeatureExtractor<F>, Path, TagProvider<T>, Tokenizer) - Constructor for class org.coordinatekit.crf.mallet.tag.MalletCrfTagger
Creates a new tagger by loading a serialized CRF model from the specified path.
MalletCrfTaggerLoader - Class in org.coordinatekit.crf.mallet.tag
The MALLET CrfTaggerLoader: deserializes a MALLET CRF model into a MalletCrfTagger.
MalletCrfTaggerLoader() - Constructor for class org.coordinatekit.crf.mallet.tag.MalletCrfTaggerLoader
Creates a loader.
MalletCrfTrainer<F,T> - Class in org.coordinatekit.crf.mallet.train
A CRF trainer implementation using the MALLET (MAchine Learning for LanguagE Toolkit) library.
MalletCrfTrainer(FeatureExtractor<F>, TagProvider<T>, TrainingDataSequencer<T>) - Constructor for class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Creates a new trainer with the specified components and default configuration.
MalletCrfTrainer(FeatureExtractor<F>, TagProvider<T>, TrainingDataSequencer<T>, MalletCrfTrainerConfiguration) - Constructor for class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Creates a new trainer with the specified components and configuration.
MalletCrfTrainerConfiguration - Class in org.coordinatekit.crf.mallet.train
Configuration settings for MalletCrfTrainer.
MalletCrfTrainerConfiguration.Builder - Class in org.coordinatekit.crf.mallet.train
Builder for constructing MalletCrfTrainerConfiguration instances.
mapSequenceToInstance(Alphabet, LabelAlphabet, TrainingSequence<T>) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Converts a training sequence into a MALLET Instance.
matchedFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor.Builder
Sets the feature to emit when a token matches the pattern.
materialize() - Method in class org.coordinatekit.crf.core.align.StreamingAlignmentReport
Captures the file's alignments into a MaterializedAlignmentReport in a single pass.
MaterializedAlignmentReport<T> - Class in org.coordinatekit.crf.core.align
An AlignmentReport that holds every SequenceAlignment in memory.
maxTokenDisplayWidth(int) - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface.Builder
Sets the maximum display width (in terminal cells) used for the token column on the sequence screen.
misaligned() - Method in interface org.coordinatekit.crf.core.align.AlignmentReport
Streams the sequences whose status is not AlignmentStatus.ALIGNED.
misaligned() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
Returns the number of AlignmentStatus.MISALIGNED sequences.
MISALIGNED - Enum constant in enum class org.coordinatekit.crf.core.align.AlignmentStatus
Re-tokenizing the surface produced a token list that differs from the stored one.
model() - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
Returns the path to a serialized model, or null if none was supplied.
model() - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
Returns the path to a serialized model, or null if none was supplied.
model(Path) - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration.Builder
Sets the path to a serialized model.
model(Path) - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration.Builder
Sets the path to a serialized model.
modelOutputConfiguration() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the configuration for model checkpoint output.
modelOutputConfiguration(ModelOutputConfiguration) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the configuration for model checkpoint output.
ModelOutputConfiguration - Class in org.coordinatekit.crf.mallet.train
Configuration settings for ModelOutputEvaluator.
ModelOutputConfiguration.Builder - Class in org.coordinatekit.crf.mallet.train
Builder for constructing ModelOutputConfiguration instances.
modelOutputEnabled() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns whether model checkpoint output is enabled during training.
modelOutputEnabled(boolean) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets whether to enable model checkpoint output during training.
ModelOutputEvaluator - Class in org.coordinatekit.crf.mallet.train
An evaluator that writes the current transducer (model) to file using Java serialization.
ModelOutputEvaluator(ModelOutputConfiguration) - Constructor for class org.coordinatekit.crf.mallet.train.ModelOutputEvaluator
Creates a new model output evaluator with the specified configuration.

N

name() - Method in interface org.coordinatekit.crf.core.tag.CrfTaggerLoader
Returns this loader's short, stable identifier, unique among the loaders on the classpath (for example "mallet").
name() - Method in class org.coordinatekit.crf.mallet.tag.MalletCrfTaggerLoader
 
NONE - Enum constant in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Neither key nor verbose display features are available.
notMatchedFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.PatternMatchingFeatureExtractor.Builder
Sets the feature to emit when a token does not match the pattern.
notPresentFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor.Builder
Sets the feature to emit when a token is not present in the value set.

O

of(FeatureExtractor<F>...) - Static method in class org.coordinatekit.crf.core.preprocessing.CompositeFeatureExtractor
Creates a new composite feature extractor from the specified extractors.
of(Sequence<TaggedPositionedToken<F, T>>, Tokenization, ToDoubleFunction<List<T>>) - Static method in class org.coordinatekit.crf.core.tag.TaggedTokenizations
Creates a tagged tokenization pairing a tagged sequence with the tokenization it came from and a function that scores arbitrary taggings of the input.
ofSegments(List<TrainingSegment<T>>) - Static method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
Creates a training sequence from an ordered list of segments.
ofTokens(List<String>, List<T>) - Static method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
Creates a training sequence from tokens and tags, with no excluded runs.
org.coordinatekit.crf.annotator - package org.coordinatekit.crf.annotator
Interactive annotation: the public tagging contract and the orchestrator that drives it.
org.coordinatekit.crf.annotator.terminal - package org.coordinatekit.crf.annotator.terminal
Terminal-based implementation of the annotator's tagging interface.
org.coordinatekit.crf.cli - package org.coordinatekit.crf.cli
The command-line front end for the interactive annotate and retokenize flows.
org.coordinatekit.crf.core - package org.coordinatekit.crf.core
Core abstractions and interfaces for Conditional Random Fields (CRF) sequence labeling.
org.coordinatekit.crf.core.align - package org.coordinatekit.crf.core.align
Read-only detection of training data that no longer matches a tokenizer.
org.coordinatekit.crf.core.io - package org.coordinatekit.crf.core.io
Input/output components for reading and writing CRF training data.
org.coordinatekit.crf.core.preprocessing - package org.coordinatekit.crf.core.preprocessing
Preprocessing components for tokenization and feature extraction in CRF pipelines.
org.coordinatekit.crf.core.spi - package org.coordinatekit.crf.core.spi
Service-provider discovery for the CRF domain SPIs.
org.coordinatekit.crf.core.tag - package org.coordinatekit.crf.core.tag
Tagging interfaces and result types for CRF sequence labeling.
org.coordinatekit.crf.core.train - package org.coordinatekit.crf.core.train
Training interfaces for CRF model construction.
org.coordinatekit.crf.core.util - package org.coordinatekit.crf.core.util
Utility classes for CRF operations.
org.coordinatekit.crf.mallet.tag - package org.coordinatekit.crf.mallet.tag
MALLET-based CRF tagging implementation.
org.coordinatekit.crf.mallet.train - package org.coordinatekit.crf.mallet.train
MALLET-based CRF training implementation.
output() - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
Returns the path to the XML output file; created or appended.
output() - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
Returns the path to the XML output file; must be absent or empty, and must differ from the input.
output(Path) - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration.Builder
Sets the path to the XML output file; created or appended.
output(Path) - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration.Builder
Sets the path to the XML output file; must be absent or empty, and must differ from the input.
outputDirectory() - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration
Returns the directory in which to write output files.
outputDirectory() - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration
Returns the directory in which to write model files.
outputDirectory(Path) - Method in class org.coordinatekit.crf.mallet.train.ConllOutputConfiguration.Builder
Sets the directory in which to write output files.
outputDirectory(Path) - Method in class org.coordinatekit.crf.mallet.train.ModelOutputConfiguration.Builder
Sets the directory in which to write model files.

P

PatternMatchingFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that matches tokens against a regex pattern.
PatternMatchingFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
position() - Method in interface org.coordinatekit.crf.core.PositionedToken
Returns the zero-based position of this token within its sequence.
PositionedToken - Interface in org.coordinatekit.crf.core
A token with its position within a sequence.
PositionFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that generates features based on token position within a sequence.
PositionFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
positionFromEndFeatureMapper(Function<Integer, F>) - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor.Builder
Sets the mapper function to generate features based on position from the end.
positionFromStartFeatureMapper(Function<Integer, F>) - Method in class org.coordinatekit.crf.core.preprocessing.PositionFeatureExtractor.Builder
Sets the mapper function to generate features based on position from the start.
present(AnnotatorSequence<F, T>) - Method in interface org.coordinatekit.crf.annotator.TaggingInterface
Presents the given sequence to the user and returns the chosen action.
present(AnnotatorSequence<F, T>) - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface
Renders the sequence screen for sequence and processes input until the annotator accepts, skips, or exits, or the input stream closes.
presentFeature(F) - Method in class org.coordinatekit.crf.core.preprocessing.XPathFeatureExtractor.Builder
Sets the feature to emit when a token is present in the value set.
probabilityOf(List<T>) - Method in interface org.coordinatekit.crf.annotator.AnnotatorSequence
Returns the conditional probability the model assigns to the given tagging of this sequence, or null when no model backs this sequence (the no-tagger path).
probabilityOf(List<T>) - Method in interface org.coordinatekit.crf.core.tag.TaggedTokenization
Returns the conditional probability P(tags | input) the model assigns to the given tag sequence over this tagging's input.

R

randomSeed() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the random seed for reproducible data splitting.
randomSeed(int) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the random seed for data splitting.
read(InputStream) - Method in interface org.coordinatekit.crf.core.io.TrainingDataSequencer
Reads training data from an input stream and returns a stream of training sequences.
read(InputStream) - Method in class org.coordinatekit.crf.core.io.XmlTrainingData
Reads training data from an input stream and returns a stream of training sequences.
read(Path) - Method in interface org.coordinatekit.crf.core.io.TrainingDataSequencer
Reads training data from a file path and returns a stream of training sequences.
reason() - Method in exception class org.coordinatekit.crf.core.preprocessing.InvalidInputException
Returns the reason why the input is invalid.
render(CommandLine.Help) - Method in class org.coordinatekit.crf.cli.Banner
Renders the brand art as the root command's header section.
REPLACEMENT - Enum constant in enum class org.coordinatekit.crf.core.align.DifferenceKind
A run of stored tokens replaced by a differing run of re-tokenized tokens; both spans are non-empty.
requestedName() - Method in exception class org.coordinatekit.crf.core.spi.UnknownServiceException
Returns the requested name that matched no provider.
Result Types - Search tag in package org.coordinatekit.crf.mallet.tag
Section
RetokenizeConfiguration - Class in org.coordinatekit.crf.annotator
Parser-free inputs for RetokenizeRunner.
RetokenizeConfiguration.Builder - Class in org.coordinatekit.crf.annotator
Builder for constructing RetokenizeConfiguration instances.
retokenizedEnd() - Method in interface org.coordinatekit.crf.core.align.TokenDifference
Returns the exclusive end index of this region within the re-tokenized list.
retokenizedStart() - Method in interface org.coordinatekit.crf.core.align.TokenDifference
Returns the inclusive start index of this region within the re-tokenized list.
retokenizedTokens() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the tokens produced by re-tokenizing the surface of SequenceAlignment.sequence().
RetokenizeReviewer<F,T> - Class in org.coordinatekit.crf.annotator
Reviews an XML training-data file against a new tokenizer and rewrites a corrected copy.
RetokenizeReviewer.Builder<F,T> - Class in org.coordinatekit.crf.annotator
Builder for RetokenizeReviewer.
RetokenizeRunner - Class in org.coordinatekit.crf.annotator
Parser-free invocation of the retokenize flow.
RetokenizeRunner.ReviewerFactory - Interface in org.coordinatekit.crf.annotator
Factory that wires the typed beans (tag provider, tokenizer, feature extractor, optional CRF tagger) into a RetokenizeReviewer.
review(Path, Path) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer
Reviews the input file against the configured tokenizer, writing a complete corrected dataset to the output file.
ReviewPreconditionException - Exception Class in org.coordinatekit.crf.annotator
Thrown when a review pass is asked to run with input or output paths that violate its fresh-pass precondition: the input and output must be different paths, and the output must be absent or empty.
ReviewPreconditionException(String) - Constructor for exception class org.coordinatekit.crf.annotator.ReviewPreconditionException
Constructs the exception with a message describing the violated precondition.
rootElementName() - Method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration
Returns the local name to use for the root element of training data documents.
rootElementName(String) - Method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration.Builder
Sets the local name to use for the root element of training data documents.
run(String[]) - Static method in class org.coordinatekit.crf.cli.CrfLauncher
Runs the tool against arguments and returns the process exit code without terminating the JVM.
run(AnnotatorConfiguration, AnnotatorRunner.AnnotatorFactory) - Static method in class org.coordinatekit.crf.annotator.AnnotatorRunner
Opens an interactive system terminal and runs the annotator produced by factory.
run(RetokenizeConfiguration, RetokenizeRunner.ReviewerFactory) - Static method in class org.coordinatekit.crf.annotator.RetokenizeRunner
Opens an interactive system terminal and runs the reviewer produced by factory.

S

Schemas and Namespaces - Search tag in package org.coordinatekit.crf.core.io
Section
score() - Method in interface org.coordinatekit.crf.core.tag.TagScore
Returns the confidence score for this tag.
Segment - Interface in org.coordinatekit.crf.core.preprocessing
One element of a surface decomposition: either a token or a dropped run of excluded characters.
SegmentKind - Enum Class in org.coordinatekit.crf.core.preprocessing
The kind of a segment: either a tagless Segment within a Tokenization or a tagged TrainingSegment within a TrainingSequence.
segments() - Method in class org.coordinatekit.crf.core.preprocessing.Tokenization
Returns the ordered segments backing this tokenization, including any excluded runs.
segments() - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
Returns the ordered segments backing this sequence, including any excluded runs.
Segments - Class in org.coordinatekit.crf.core.preprocessing
Factory for tag-less Segment instances and the shared surface-reconstruction helper.
sequence() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the stored training sequence this alignment was computed from.
sequence() - Method in class org.coordinatekit.crf.core.preprocessing.Tokenization
Returns the token-only projection of this tokenization.
Sequence<E> - Interface in org.coordinatekit.crf.core
Represents an ordered sequence of positioned tokens.
SEQUENCE_ELEMENT_NAME - Static variable in class org.coordinatekit.crf.core.io.XmlTrainingData
The local name of the element that contains a training sequence.
sequenceAlignment(int, AlignmentStatus, TrainingSequence<T>, List<String>, TokenComparison, String) - Static method in class org.coordinatekit.crf.core.align.AlignmentModels
SequenceAlignment<T> - Interface in org.coordinatekit.crf.core.align
The alignment result for a single stored training sequence.
sequenceIndex() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the zero-based index of this sequence within its source file, in document order.
sequenceNumber() - Method in interface org.coordinatekit.crf.annotator.AnnotatorSequence
Returns the 1-based position of this sequence within the overall annotation batch.
sequences() - Method in interface org.coordinatekit.crf.core.align.AlignmentReport
Streams the per-sequence alignment results in document order.
sequences() - Method in class org.coordinatekit.crf.core.align.MaterializedAlignmentReport
 
sequences() - Method in class org.coordinatekit.crf.core.align.StreamingAlignmentReport
Streams the per-sequence alignment results in document order.
Serializables - Class in org.coordinatekit.crf.core.util
Utility methods for serializing and deserializing objects to and from files.
serialize(T, Path) - Static method in class org.coordinatekit.crf.core.util.Serializables
Serializes an object to a file.
serviceName() - Method in exception class org.coordinatekit.crf.core.spi.AmbiguousServiceException
Returns the human-readable name of the ambiguous service, derived from AmbiguousServiceException.serviceType().
serviceName() - Method in exception class org.coordinatekit.crf.core.spi.UnknownServiceException
Returns the human-readable name of the service type.
serviceType() - Method in exception class org.coordinatekit.crf.core.spi.AmbiguousServiceException
Returns the type of the ambiguous service, the authoritative identity for callers that tailor guidance per slot.
SimpleTrainingTestSplit - Record Class in org.coordinatekit.crf.mallet.train
A container for training and test data splits.
SimpleTrainingTestSplit(InstanceList, InstanceList) - Constructor for record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Creates an instance of a SimpleTrainingTestSplit record class.
size() - Method in class org.coordinatekit.crf.core.InputSequence
 
size() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureSequence
 
size() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureTrainingSequence
 
size() - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
 
size() - Method in interface org.coordinatekit.crf.core.Sequence
Returns the number of tokens in this sequence.
size() - Method in class org.coordinatekit.crf.core.tag.TaggedSequence
 
size() - Method in interface org.coordinatekit.crf.mallet.train.TrainingTestSplit
Returns the total number of instances across both training and test sets.
SKIP - Enum constant in enum class org.coordinatekit.crf.annotator.TaggingAction
The user chose to skip the current sequence without producing a tagging.
smallArt() - Method in interface org.coordinatekit.crf.cli.Banner.Product
The small wordmark art, one string per row.
SOME_DENSE - Enum constant in enum class org.coordinatekit.crf.mallet.train.WeightsType
Use a hybrid approach with some dense and some sparse weights.
source() - Method in interface org.coordinatekit.crf.core.align.AlignmentReport
Returns the file these results are computed from.
source() - Method in class org.coordinatekit.crf.core.align.MaterializedAlignmentReport
 
source() - Method in class org.coordinatekit.crf.core.align.StreamingAlignmentReport
 
SPARSE - Enum constant in enum class org.coordinatekit.crf.mallet.train.WeightsType
Use sparse weight storage for all features.
splitTrainingData(Collection<Path>) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
Reads training data and splits it into training and test sets.
startingTag() - Method in class org.coordinatekit.crf.core.StringTagProvider
 
startingTag() - Method in interface org.coordinatekit.crf.core.TagProvider
Returns the starting/fallback tag for the CRF.
status() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the alignment outcome for this sequence.
storedEnd() - Method in interface org.coordinatekit.crf.core.align.TokenDifference
Returns the exclusive end index of this region within the stored list.
storedStart() - Method in interface org.coordinatekit.crf.core.align.TokenDifference
Returns the inclusive start index of this region within the stored list.
storedTokens() - Method in interface org.coordinatekit.crf.core.align.SequenceAlignment
Returns the tokens stored in the training data for this sequence.
stream() - Method in class org.coordinatekit.crf.core.InputSequence
 
stream() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureSequence
 
stream() - Method in class org.coordinatekit.crf.core.preprocessing.FeatureTrainingSequence
 
stream() - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
 
stream() - Method in interface org.coordinatekit.crf.core.Sequence
Returns a sequential Stream over the tokens in this sequence.
stream() - Method in class org.coordinatekit.crf.core.tag.TaggedSequence
 
StreamingAlignmentReport<T> - Class in org.coordinatekit.crf.core.align
A live AlignmentReport that re-reads its source file on every accessor.
StringTagProvider - Class in org.coordinatekit.crf.core
A tag provider for string tags with a defined tag set and starting tag.
StringTagProvider(String) - Constructor for class org.coordinatekit.crf.core.StringTagProvider
Constructs a new string tag provider with the starting tag.
StringTagProvider(Collection<String>, String) - Constructor for class org.coordinatekit.crf.core.StringTagProvider
Constructs a new string tag provider with the specified tags and starting tag.
SubstringFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that generates features based on prefixes or suffixes of tokens.
SubstringFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
summary() - Method in interface org.coordinatekit.crf.core.align.AlignmentReport
Summarizes the file's alignments into a per-status tally.
summary() - Method in class org.coordinatekit.crf.core.align.MaterializedAlignmentReport
 
summary() - Method in class org.coordinatekit.crf.core.align.StreamingAlignmentReport
Summarizes the file's alignments into a per-status tally.
surface() - Method in class org.coordinatekit.crf.core.preprocessing.Tokenization
Reconstructs the original surface string by concatenating every segment's text in document order.
surface() - Method in class org.coordinatekit.crf.core.preprocessing.TrainingSequence
Reconstructs the surface text of this sequence by concatenating every segment's text in document order.

T

tag() - Method in interface org.coordinatekit.crf.core.preprocessing.FeatureTrainingPositionedToken
Returns the training tag (label) for this token.
tag() - Method in interface org.coordinatekit.crf.core.preprocessing.TrainingPositionedToken
Returns the training tag (label) for this token.
tag() - Method in interface org.coordinatekit.crf.core.preprocessing.TrainingSegment
Returns the tag for this segment, or null when this segment is not a token.
tag() - Method in interface org.coordinatekit.crf.core.tag.TaggedPositionedToken
Returns the highest-scoring tag for this token.
tag() - Method in interface org.coordinatekit.crf.core.tag.TagScore
Returns the tag value.
tag(int) - Method in interface org.coordinatekit.crf.core.tag.TaggedPositionedToken
Returns an iterator over the top N tags for this token, ordered by score descending.
tag(String) - Method in interface org.coordinatekit.crf.core.tag.CrfTagger
Tags the tokens in the input string using the CRF model.
tag(String) - Method in class org.coordinatekit.crf.mallet.tag.MalletCrfTagger
 
TaggedPositionedToken<F,T> - Interface in org.coordinatekit.crf.core.tag
A positioned token that includes the scores for each tag.
taggedSequence() - Method in interface org.coordinatekit.crf.core.tag.TaggedTokenization
Returns the per-token tagging output: each token's features and ranked tag scores.
TaggedSequence<F,T> - Class in org.coordinatekit.crf.core.tag
A sequence of tokens that have been tagged by a CRF model with associated features and tag scores.
TaggedSequence(List<String>, List<Set<F>>, List<Map<T, Double>>) - Constructor for class org.coordinatekit.crf.core.tag.TaggedSequence
Creates a new tagged sequence from parallel lists of tokens, features, and tag scores.
TaggedTokenization<F,T> - Interface in org.coordinatekit.crf.core.tag
The full result of tagging an input string: the per-token tags paired with the authoritative Tokenization the tagger computed.
TaggedTokenizations - Class in org.coordinatekit.crf.core.tag
Factory for TaggedTokenization instances.
tagger(CrfTagger<F, T>) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the CRF tagger used to suggest tags for each input line.
tagger(CrfTagger<F, T>) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the CRF tagger used to suggest tags when re-tagging a misaligned sequence.
taggerLoader() - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Discovers the tagger loader by single registered CrfTaggerLoader > none.
taggerLoader(CrfTaggerLoader) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the tagger loader by explicit > single registered CrfTaggerLoader > none.
taggerLoader(CrfTaggerLoader, String) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the tagger loader by explicit > name-matched registered CrfTaggerLoader > single registered CrfTaggerLoader > none.
TaggingAction - Enum Class in org.coordinatekit.crf.annotator
The action selected by the user when presented with a sequence to tag.
taggingInterface(TaggingInterface<F, T>) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the tagging interface used to present each sequence to the user.
taggingInterface(TaggingInterface<F, T>) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the tagging interface used to present each misaligned sequence to the user.
TaggingInterface<F,T> - Interface in org.coordinatekit.crf.annotator
Presents a single sequence to a user for tagging and reports the outcome.
taggingResult(TaggingAction, List<T>) - Static method in class org.coordinatekit.crf.annotator.AnnotatorModels
Creates a TaggingResult.
TaggingResult<T> - Interface in org.coordinatekit.crf.annotator
The outcome of presenting a sequence to a user for tagging.
tagProvider - Variable in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
The tag provider defining available tags and their encoding/decoding.
tagProvider() - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Discovers the tag provider by single registered TagProvider > none.
tagProvider(TagProvider<T>) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the tag provider by explicit > single registered TagProvider > none.
tagProvider(TagProvider<T>) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the tag provider, whose TagProvider.tags() set defines the tag space.
tagProvider(TagProvider<T>) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the tag provider, whose TagProvider.tags() set defines the tag space.
tagProvider(TagProvider<T>) - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface.Builder
Sets the tag provider, whose TagProvider.tags() set defines the tag space offered on the edit screen.
TagProvider<T> - Interface in org.coordinatekit.crf.core
Provides tag information for CRF models, including conversion, enumeration, and the starting state.
tags() - Method in class org.coordinatekit.crf.core.StringTagProvider
 
tags() - Method in interface org.coordinatekit.crf.core.TagProvider
Returns all valid tags in the model's label space.
TagScore<T> - Interface in org.coordinatekit.crf.core.tag
A tag with its associated confidence score.
tagScores() - Method in interface org.coordinatekit.crf.core.tag.TaggedPositionedToken
Returns an iterator over all tag scores for this token, ordered by score descending.
targetNamespace() - Method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration
Returns the target namespace used for XSD schema generation, or null if tag elements should sit in no namespace.
targetNamespace(String) - Method in class org.coordinatekit.crf.core.io.XmlTrainingDataConfiguration.Builder
Sets the target namespace used for XSD schema generation.
terminal(Terminal) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the JLine terminal used to emit the one-line resume message at session start.
terminal(Terminal) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the JLine terminal used to emit untokenizable warnings and the closing summary.
terminal(Terminal) - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface.Builder
Sets the JLine terminal used for input and output.
TerminalTaggingInterface<F,T> - Class in org.coordinatekit.crf.annotator.terminal
A TaggingInterface implementation that drives a JLine-backed terminal.
TerminalTaggingInterface.Builder<F,T> - Class in org.coordinatekit.crf.annotator.terminal
test() - Method in record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Returns the value of the test record component.
test() - Method in interface org.coordinatekit.crf.mallet.train.TrainingTestSplit
Returns the instances to use for model evaluation.
text() - Method in interface org.coordinatekit.crf.core.preprocessing.Segment
Returns the surface text of this segment.
threads() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the number of threads to use for parallel training.
threads(int) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the number of threads for parallel training.
threshold() - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration
Returns the confidence threshold below which token rows are highlighted on the sequence screen.
threshold() - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration
Returns the confidence threshold below which token rows are highlighted on the sequence screen.
threshold(double) - Method in class org.coordinatekit.crf.annotator.AnnotatorConfiguration.Builder
Sets the confidence threshold below which token rows are highlighted.
threshold(double) - Method in class org.coordinatekit.crf.annotator.RetokenizeConfiguration.Builder
Sets the confidence threshold below which token rows are highlighted.
threshold(double) - Method in class org.coordinatekit.crf.annotator.terminal.TerminalTaggingInterface.Builder
Sets the confidence threshold below which token rows are highlighted (bold + yellow) on the sequence screen.
token() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the raw token string.
token() - Method in interface org.coordinatekit.crf.core.PositionedToken
Returns the token value.
token(String) - Static method in class org.coordinatekit.crf.core.preprocessing.Segments
Creates a TOKEN segment carrying token text.
token(T, String) - Static method in class org.coordinatekit.crf.core.preprocessing.TrainingSegments
Creates a TOKEN segment carrying a tagged token.
TOKEN - Enum constant in enum class org.coordinatekit.crf.core.preprocessing.SegmentKind
A token; it carries both text and a tag.
tokenComparison(List<TokenDifference>) - Static method in class org.coordinatekit.crf.core.align.AlignmentModels
Creates a TokenComparison.
TokenComparison - Interface in org.coordinatekit.crf.core.align
The outcome of comparing a stored token list against a re-tokenized one.
tokenDifference(DifferenceKind, int, int, int, int) - Static method in class org.coordinatekit.crf.core.align.AlignmentModels
Creates a TokenDifference.
TokenDifference - Interface in org.coordinatekit.crf.core.align
A single region where a stored token list and a re-tokenized one diverge.
tokenization() - Method in interface org.coordinatekit.crf.core.tag.TaggedTokenization
Returns the authoritative tokenization, carrying both the token segments and the excluded runs the tokenizer dropped around them.
Tokenization - Class in org.coordinatekit.crf.core.preprocessing
The result of tokenizing raw text: an ordered list of segments recording every token and every excluded character run a Tokenizer dropped around them.
Tokenization(List<Segment>) - Constructor for class org.coordinatekit.crf.core.preprocessing.Tokenization
Creates a tokenization from an ordered list of segments, computing the token-only projection.
tokenize(String) - Method in interface org.coordinatekit.crf.core.preprocessing.Tokenizer
Tokenizes the input string into tokens and the excluded character runs dropped around them.
tokenize(String) - Method in class org.coordinatekit.crf.core.preprocessing.WhitespaceTokenizer
Tokenizes the input string into tokens and the excluded character runs dropped around them.
tokenizer() - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the tokenizer by single registered Tokenizer > WhitespaceTokenizer.
tokenizer(Tokenizer) - Static method in class org.coordinatekit.crf.core.spi.CrfServices
Resolves the tokenizer by explicit > single registered Tokenizer > WhitespaceTokenizer.
tokenizer(Tokenizer) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the tokenizer used to split every input line into tokens and excluded runs.
tokenizer(Tokenizer) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the tokenizer used to re-tokenize each sequence's surface.
Tokenizer - Interface in org.coordinatekit.crf.core.preprocessing
Converts raw text input into a sequence of tokens.
tokens() - Method in interface org.coordinatekit.crf.annotator.AnnotatorSequence
Returns the per-token entries for the sequence.
toString() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
 
toString() - Method in record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Returns a string representation of this record class.
total() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
Returns the total number of sequences in the file.
totalSequences() - Method in interface org.coordinatekit.crf.annotator.AnnotatorSequence
Returns the total number of sequences in the overall annotation batch.
train(Path, Path) - Method in interface org.coordinatekit.crf.core.train.CrfTrainer
Trains a CRF model using the training data at the specified path and saves the model to the specified output path.
train(Collection<Path>, Path) - Method in interface org.coordinatekit.crf.core.train.CrfTrainer
Trains a CRF model using the training data at the specified paths and saves the model to the specified output path.
train(Collection<Path>, Path) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
 
training() - Method in record class org.coordinatekit.crf.mallet.train.SimpleTrainingTestSplit
Returns the value of the training record component.
training() - Method in interface org.coordinatekit.crf.mallet.train.TrainingTestSplit
Returns the training instances to use for model training.
TrainingDataAppender<T> - Interface in org.coordinatekit.crf.core.io
Opens training sequence writers that append to existing training data files.
Training Data Format - Search tag in package org.coordinatekit.crf.core.io
Section
trainingDataSequencer - Variable in class org.coordinatekit.crf.mallet.train.MalletCrfTrainer
The sequencer for reading training data from files into training sequences.
TrainingDataSequencer<T> - Interface in org.coordinatekit.crf.core.io
Reads training data and converts it into a stream of training sequences.
TrainingDataStreamer<T> - Interface in org.coordinatekit.crf.core.io
Opens training sequence writers that emit a fresh document to an output stream.
TrainingDataValidator - Interface in org.coordinatekit.crf.core.io
Validates CRF training data documents against the structural grammar and the tag vocabulary.
trainingFraction() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the fraction of data to use for training.
trainingFraction(double) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the fraction of data to use for training.
TrainingPositionedToken<T> - Interface in org.coordinatekit.crf.core.preprocessing
A positioned token that includes a training label.
TrainingSchemaGenerator - Interface in org.coordinatekit.crf.core.io
Generates schema definitions for validating CRF training data.
TrainingSegment<T> - Interface in org.coordinatekit.crf.core.preprocessing
One element of a TrainingSequence: either a tagged token or a dropped run of excluded characters.
TrainingSegments - Class in org.coordinatekit.crf.core.preprocessing
Factory for TrainingSegment instances.
TrainingSequence<T> - Class in org.coordinatekit.crf.core.preprocessing
A sequence of tagged tokens, backed by an ordered list of segments that also preserves the excluded characters dropped around the tokens.
TrainingSequence(List<String>, List<T>) - Constructor for class org.coordinatekit.crf.core.preprocessing.TrainingSequence
Deprecated.
since 0.2.0 — this token-only constructor invents no excluded runs, so the resulting TrainingSequence.surface() is the bare token concatenation. Prefer TrainingSequence.ofSegments(List) to preserve excluded characters, or TrainingSequence.ofTokens(List, List) when no excluded runs exist.
TrainingSequenceWriter<T> - Interface in org.coordinatekit.crf.core.io
Writes training sequences to an output destination.
TrainingTestSplit - Interface in org.coordinatekit.crf.mallet.train
A container for training and test data splits.
TransformingFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that applies a transformation function to each token to produce features.
TransformingFeatureExtractor(Function<String, Set<F>>) - Constructor for class org.coordinatekit.crf.core.preprocessing.TransformingFeatureExtractor
Creates a new transforming feature extractor with the specified transformation function.

U

UncheckedCrfException - Exception Class in org.coordinatekit.crf.core
Unchecked exception thrown when an error occurs during conditional random field (CRF) operations.
UncheckedCrfException() - Constructor for exception class org.coordinatekit.crf.core.UncheckedCrfException
Constructs a new exception with no detail message.
UncheckedCrfException(String) - Constructor for exception class org.coordinatekit.crf.core.UncheckedCrfException
Constructs a new exception with the specified detail message.
UncheckedCrfException(String, Throwable) - Constructor for exception class org.coordinatekit.crf.core.UncheckedCrfException
Constructs a new exception with the specified detail message and cause.
UncheckedCrfException(Throwable) - Constructor for exception class org.coordinatekit.crf.core.UncheckedCrfException
Constructs a new exception with the specified cause.
UnknownServiceException - Exception Class in org.coordinatekit.crf.core.spi
Thrown when a service was requested by name but no registered provider of the service type carries that name.
UnknownServiceException(String, String, List<String>) - Constructor for exception class org.coordinatekit.crf.core.spi.UnknownServiceException
Constructs an exception naming the requested service, the name that matched nothing, and the names that were available.
untokenizable() - Method in class org.coordinatekit.crf.core.align.AlignmentSummary
Returns the number of AlignmentStatus.UNTOKENIZABLE sequences.
UNTOKENIZABLE - Enum constant in enum class org.coordinatekit.crf.core.align.AlignmentStatus
The tokenizer rejected the reconstructed surface, so no comparison was possible.

V

validate(InputStream) - Method in interface org.coordinatekit.crf.core.io.TrainingDataValidator
Validates the training data read from the given input stream.
validate(InputStream) - Method in class org.coordinatekit.crf.core.io.XmlTrainingData
Validates the training data read from the given input stream.
validate(Path) - Method in interface org.coordinatekit.crf.core.io.TrainingDataValidator
Validates the training data stored in the given file.
valueOf(String) - Static method in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.coordinatekit.crf.annotator.TaggingAction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.coordinatekit.crf.core.align.AlignmentStatus
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.coordinatekit.crf.core.align.DifferenceKind
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.coordinatekit.crf.core.preprocessing.SegmentKind
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.coordinatekit.crf.mallet.train.WeightsType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.coordinatekit.crf.annotator.TaggingAction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.coordinatekit.crf.core.align.AlignmentStatus
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.coordinatekit.crf.core.align.DifferenceKind
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.coordinatekit.crf.core.preprocessing.SegmentKind
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.coordinatekit.crf.mallet.train.WeightsType
Returns an array containing the constants of this enum class, in the order they are declared.
VERBOSE_ONLY - Enum constant in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Only verbose display features are available.
verboseAvailable() - Method in enum class org.coordinatekit.crf.annotator.FeatureAvailability
Returns whether verbose display features are available, enabling the all-features view.
verboseFeatureExtractor(FeatureExtractor<F>) - Method in class org.coordinatekit.crf.annotator.Annotator.Builder
Sets the feature extractor used to compute the verbose display features shown only by the all-features view of the tagging interface.
verboseFeatureExtractor(FeatureExtractor<F>) - Method in class org.coordinatekit.crf.annotator.RetokenizeReviewer.Builder
Sets the feature extractor used to compute the verbose display features shown only by the all-features view of the tagging interface.
verboseFeatures() - Method in interface org.coordinatekit.crf.annotator.AnnotatorToken
Returns the verbose display features for this token — the noisier extras shown only in the all-features view, in addition to features.

W

weightsType() - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration
Returns the weight storage type for the CRF.
weightsType(WeightsType) - Method in class org.coordinatekit.crf.mallet.train.MalletCrfTrainerConfiguration.Builder
Sets the weight storage type.
WeightsType - Enum Class in org.coordinatekit.crf.mallet.train
Specifies the weight storage strategy for CRF training.
WhitespaceTokenizer - Class in org.coordinatekit.crf.core.preprocessing
A tokenizer that splits input on whitespace characters.
WhitespaceTokenizer() - Constructor for class org.coordinatekit.crf.core.preprocessing.WhitespaceTokenizer
Creates a new whitespace tokenizer.
windowAfter(int) - Method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor.Builder
Sets the number of tokens to look forward from the current position.
windowBefore(int) - Method in class org.coordinatekit.crf.core.preprocessing.WindowFeatureExtractor.Builder
Sets the number of tokens to look back from the current position.
WindowFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that extracts features from the current token and neighboring tokens within a window.
WindowFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
Builder for constructing WindowFeatureExtractor instances.
WindowFeatureMapper<F> - Interface in org.coordinatekit.crf.core.preprocessing
A function that maps a feature to a new feature based on its relative position.
write(TrainingSequence<T>) - Method in interface org.coordinatekit.crf.core.io.TrainingSequenceWriter
Writes a single training sequence to the output.
writer(OutputStream) - Method in interface org.coordinatekit.crf.core.io.TrainingDataStreamer
Opens a training sequence writer that emits a fresh document to the given output stream.
writer(OutputStream) - Method in class org.coordinatekit.crf.core.io.XmlTrainingData
Opens a single-pass training sequence writer to the given output stream.

X

XmlTrainingData<T> - Class in org.coordinatekit.crf.core.io
Reads and writes CRF training data in XML format, and generates XSD schemas for tag validation.
XmlTrainingData(TagProvider<T>) - Constructor for class org.coordinatekit.crf.core.io.XmlTrainingData
Constructs an XmlTrainingData instance with default configuration.
XmlTrainingData(TagProvider<T>, String) - Constructor for class org.coordinatekit.crf.core.io.XmlTrainingData
Deprecated.
since 0.2.0 — pass an XmlTrainingDataConfiguration via XmlTrainingData(TagProvider, XmlTrainingDataConfiguration) instead. The configuration object also lets callers customize the root element name.
XmlTrainingData(TagProvider<T>, XmlTrainingDataConfiguration) - Constructor for class org.coordinatekit.crf.core.io.XmlTrainingData
Constructs an XmlTrainingData instance with the given configuration.
XmlTrainingDataConfiguration - Class in org.coordinatekit.crf.core.io
Configuration settings for XmlTrainingData.
XmlTrainingDataConfiguration.Builder - Class in org.coordinatekit.crf.core.io
Builder for constructing XmlTrainingDataConfiguration instances.
XPathFeatureExtractor<F> - Class in org.coordinatekit.crf.core.preprocessing
A feature extractor that checks whether tokens are present in a set of values loaded from an XML file using XPath expressions.
XPathFeatureExtractor.Builder<F> - Class in org.coordinatekit.crf.core.preprocessing
A B C D E F G H I K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form