API Reference

Complete autodoc for the public surface of cmenpy, organized by kind. Every class, function and type alias the framework exposes is documented here, and each symbol links to the page that documents it.

Browse	Contents
Classes	Optimizers, field markers, population, buffer, objectives, search space, runtime, protocols, aliases
Functions	Declaration decorators, kernel decorators, signature markers, builders, introspection, comparators
Modules	One entry per subpackage, with its docstring and links to its symbols

How to read this reference

Documentation is generated from the source via mkdocstrings. Signatures are shown with their annotations, and class initializers are merged into the class entry.

Symbol index

Symbol	Kind	Page
Array, Scalar	compile markers	Functions
Contract	compile marker	Functions
precompile, vectorize, reduce	decorators	Functions
jit	decorator (deprecated)	Functions
kernels, prepare	introspection	Functions
declare, template	model decorators	Functions
module	Operator Module decorator	Functions
vectorized_target	decorator	Functions
declare_from_func, declare_from_class, build_context_manager	builders	Functions
create_bounds, init_buffer	factories	Functions
cast	explicit casting	Functions
is_best, is_worst	comparators	Functions
best_index, worst_index	ranking helpers	Functions
Argument, Constant, Variable	field markers	Classes
BaseOptimizer	abstract base	Classes
FunctionOptimizerModel, TemplateOptimizerModel	models	Classes
ModelProtocol, AlgorithmFunction, CallableFunction	protocols	Classes
FunctionParamsArguments	arguments holder	Classes
ExceptionTypeParams, ExceptionValueParams	exceptions	Classes
PopulationSwarm	population handle	Classes
StreamOperations	operator set	Classes
ComputeOperator, AssignOperator, AccessOperator, ExtractOperation, SwapOperation	operators	Classes
ComputePipeline, AssignPipeline	per-row targets	Classes
StreamOperator, ReaderOperator, WriterOperator, VectorizableOperator, PipelineOperator	operator ABCs	Classes
BufferMatrixOperations, BufferMatrixFitness, BufferMatrixSolutions	matrix views	Classes
BufferMatrixAbstract, BufferMatrixAccess, BufferMatrixCompute	matrix ABCs	Classes
DynamicBase, BaseIterator	population bases	Classes
KernelBuffer	buffer	Classes
KernelMask, KernelSize	buffer support	Classes
BufferIndex	ranking	Classes
Target, TargetFunction	objective	Classes
VectorizedTarget	vectorized objective	Classes
MaxNumberOfCalls	exception	Classes
Bounds	search space	Classes
Context, MainContextManager	run context	Classes
EpochIteration	epoch iterator	Classes
Tracker, EpochHistory	history	Classes
DefaultGenerator	RNG	Classes
NDArrayType, ArrayFloatType, ArrayIntegerType	array aliases	Classes
ScalarType, SenseType	scalar/option aliases	Classes