Browse documentation
aner.ml · Reference

Models and techniques

Choose a supported model, inspect every configuration variable, follow reproducible examples and understand fitted state, shapes and capability limits.

Released in Aner 0.0.5Aner 0.0.5 or newer

Choose a model below, then use its parameter guide before changing an experiment. Each reference explains the supported native configuration, required inputs, output shapes, parameter effects, fitting and prediction lifecycle, reproducibility, resource limits and worked examples.

K nearest neighbors, K means, decision trees and contextual linear regression belong to aner.ml. Neural topology, differentiable operations and explicit optimizers belong to aner.nn; Dense classifier plans and training configurations use aner.ml. These are functions and native value types, not separately importable model submodules.

Choose a model

Model or techniqueWhat it producesDetailed referenceRunnable source
Natural language processingSparse lexical features, source linked evidence and exact neural token batchesNLP parameters and behaviorClassification, retrieval and neural workflows
K nearest neighbor classificationClass IDs, uniform vote fractions and nearest row inspectionKNN parameters and behaviorComplete KNN inspection
K means clusteringCenters, fitted assignments, new row cluster IDs and convergence readoutsK means parameters and behaviorComplete K means inspection
Decision tree classificationClass IDs, leaf vote probabilities and an inspectable numeric binary treeDecision tree parameters and criteriaDecision tree workflow
Contextual linear regressionNumerical targets with fitted feature transformations, row identity and declared target meaningFeatureLedger and linear regressionBuilding energy workflow
Dense neural classificationTrained Dense weights, fitted preprocessing, probabilities and classification reportsDense model and training parametersTraining, validation and checkpoint continuation
POS and named entity taggingSource aligned sequence labels, strict entities, error metrics and exact resumable trainingTagging parametersPOS and NER case studies
SGD and AdamExplicit parameter updates and optimizer stateOptimizer parameters and stateAdam checkpoint continuation
Convolutional networksNCHW image classifiers and configured architecture graphsCNN layer, architecture and fitting parametersCNN builders
Recurrent networksRNN, LSTM and GRU sequence models, explicit state and supported advanced profilesRecurrent model and fitting parametersRecurrent workflow
Causal decoder and scientific generatorsNative language model and bounded scientific generation experimentsGenerative model and training parametersDecoder training

The complete model API parameter index lists the supported signature families and explains each argument. Use machine learning, neural networks, sequence primitives, evaluation metrics and dataset partitions for the shared contracts.

Read a parameter reference

  • Required means the argument must be supplied to that native signature. A documented default exists only where an implemented overload supplies it. Examples are experiment settings, not hidden defaults or recommended values for every dataset.
  • Type and shape describe the value the checker or runtime accepts. A feature matrix, label column, logit matrix and cluster assignment can all be Tensor values while having different meanings and shapes.
  • Range and effect explain admissible values and how the parameter changes the algorithm. A parameter absent from a model's signature is not supported merely because another model has it.
  • Fitted state describes what the model retains and what the caller must keep separately. KNN's standardizer remains caller owned; a fitted Dense classifier owns its preprocessing.
  • Randomness identifies which operation owns the seed and whether repeated calls restart or continue it. KNN has deterministic row order ties and no seed parameter. Dense dropout has its own optional replay seed and persistent update schedule.
  • Checkpoint behavior is model specific. Dense, CNN, recurrent and generative formats have distinct contracts. Native KNN and K means do not gain serialization from the Dense checkpoint API.

Keep the comparison meaningful

Split training, validation and test roles before fitting preprocessing. Use validation to compare model settings; keep the final test partition out of tuning. Preserve original row mappings when extracting raw Tensor inputs, because those tensors no longer carry the Dataset role audit automatically.

Record the data source and row order, transformations, complete model settings, seeds and schedules, numerical backend, precision, runtime identity and outputs. A seed controls a documented random protocol; it does not make arbitrary software or device changes numerically identical. Compare probability losses with the intended label mapping and distinguish online training observations from detached evaluation metrics.

Availability of these references

These pages describe the reviewed implementation. Optional accelerator or distributed support depends on the installed build and available hardware. Dense dropout, its optional seed and version 7 checkpoint trace require the matching updated runtime. Updating documentation or an editor package does not publish a runtime or establish new binary availability. Check the runtime status and model specific capability notes when choosing an executable.

Aner documentation · Reference and guides