Chronaxis用户手册English
本页目录计划加载与检查执行与结果批量任务高性能积分器自定义分析算子业务预设时间转换功能与配置关联

Python公开API索引

按调用任务查询公开入口。每个名称进入单独的公开对象页,包含完整构造签名、公开方法/属性、参数、返回值和异常。通用分析、批量、预设和时间入口从chronaxis导入;高性能积分器和自定义分析算子在各节注明实际导入模块;结果行模型见结果结构,内部模块见开发参考。从文件运行的完整流程见Python快速开始。

计划加载与检查

公开名称 定义与用途
chronaxis.AnalysisPlan AnalysisPlan:保存一个会话的分析配置,以及静态检查得到的对象。
chronaxis.load_analysis_plan load_analysis_plan:读取JSON/YAML配置及一层公共定义,按各自声明目录解释相对来源路径。
chronaxis.validate_analysis_plan validate_analysis_plan:报告静态配置有效性及当前读取、执行和发布能力限制。
chronaxis.explain_analysis_plan explain_analysis_plan:列出计划依赖、各节点计算方式、历史需求和预算声明。
chronaxis.PlanValidationError PlanValidationError:保存配置字段路径、原因、机器错误码及可选的原文定位和修正建议。

执行与结果

公开名称 定义与用途
chronaxis.AnalysisRunner AnalysisRunner:保存可选后端覆盖,复用同一静态校验,逐次创建独立运行资源。
chronaxis.AnalysisResult AnalysisResult:保存暂存路径和小型元数据,无events/segments/calculations全量列表。
chronaxis.OutputManifest OutputManifest:保存成功发布目录、清单和固定白名单表行数;legacy只在启用时出现。
chronaxis.ExportManifest ExportManifest:提供直接信号CSV或原帧导出的实际目录、完成清单及数据文件路径。
chronaxis.RunMetadata RunMetadata:保存运行身份、实际后端、时间解释、会话边界与兼容限制。
chronaxis.AnalysisError AnalysisError:表示分析或结果交付失败;异常本身不承诺旧输出已回滚。
chronaxis.ResultClosedError ResultClosedError:表示结果已经关闭,不能再创建迭代器、读取或发布。

批量任务

公开名称 定义与用途
chronaxis.BatchPlan BatchPlan:保存批量选项及独立任务列表;任务可引用分析配置路径或已加载的分析计划。同一连续会话仍放在一个任务中。
chronaxis.BatchJob BatchJob:声明一个独立分析;同会话连续文件应包含在本任务的一个计划中。
chronaxis.BatchJobResult BatchJobResult:保存一个任务的最终状态;发布后关闭失败仍为failed,并保留已发布路径。
chronaxis.BatchReport BatchReport:按原任务顺序汇总结果;每个任务数值表仍在各自目录,不会把不同任务的数值相加。
chronaxis.BatchRunner BatchRunner:通过process_count设置分析工作进程数,每次run创建并回收本批的工作进程;不跨批次缓存计划和状态。
chronaxis.load_batch_plan load_batch_plan:读取严格批量JSON/YAML。参数: path为UTF-8配置文件。返回: BatchPlan。异常: 带路径配置错误。
chronaxis.run_batch run_batch:运行并发布批量报告。

高性能积分器

公开入口 使用场景
chronaxis.fast.run 同帧逐报文累计;能量公式须包含时间因子,见积分器指南。
chronaxis.fast.batch.run_batch 对多个独立文件执行上述计算,可请求可比计算项的整批总量。

使用from chronaxis.fast import run和from chronaxis.fast.batch import run_batch导入上述入口。

自定义分析算子

使用from chronaxis.extensions import ExtensionRegistry, FunctionSpec, ReductionSpec, TransformSpec导入以下对象。

公开入口 使用场景
ExtensionRegistry 加载与执行计划时传入同一注册表。
FunctionSpec 注册表达式中逐值调用的函数。
ReductionSpec 注册对一个统计范围内多行数据求值的统计操作。
TransformSpec 注册按时间窗口求值的计算。

参数、生命周期和完整示例见自定义分析算子。

业务预设

公开名称 定义与用途
chronaxis.PresetSpec PresetSpec:保存预设实例名、任务类型、模板版本、角色与信号对应关系及业务参数;通过from_dict建立不可修改的声明。
chronaxis.PlanFragment PlanFragment:保存预设生成的公共节点,不含来源、执行器或真实样本。
chronaxis.build_preset build_preset:校验v1预设并展开公共声明,不执行I/O或数值分析。
chronaxis.resolve_preset_roles resolve_preset_roles:先使用role_bindings明确指定的信号;未指定的角色再按semantic_id和semantic_contract_version查找唯一符合角色要求的信号。

时间转换

公开名称 定义与用途
chronaxis.TimeConversion TimeConversion:保存规范时间及来源精度,避免跨任务修改转换诊断。
chronaxis.TimeOverflowError TimeOverflowError:时间坐标、偏移后坐标或非负跨度超出int64时拒绝运算。
chronaxis.checked_add_ns checked_add_ns:为一个纳秒坐标添加固定偏移,并检查结果是否仍在int64范围内。
chronaxis.convert_time convert_time:按明确单位换算纳秒,并在最终结果处取最近偶数舍入。
chronaxis.parse_datetime_ns parse_datetime_ns:将ISO完整日期转换为UTC整数纳秒,保留亚微秒分数。
chronaxis.parse_duration parse_duration:解析带单位的非负持续参数,允许显式零长度。
chronaxis.shift_times_reference shift_times_reference:逐项独立计算固定偏移,作为数组内核的整数真值参考。
chronaxis.time_deltas_reference time_deltas_reference:计算非递减整数时间的相邻跨度,允许同时间不同样本。

功能与配置关联

配置或任务 功能指南 主要API
配置文件与公共定义 配置结构、公共定义 load_analysis_plan、AnalysisPlan.from_dict
事件、窗口和计算 规则、窗口、计算 AnalysisRunner.run、AnalysisResult迭代方法
独立任务批量运行 批量任务 load_batch_plan、run_batch
预设角色及声明生成 业务预设 PresetSpec、resolve_preset_roles、build_preset
时间单位和日期 时间与结果质量 parse_duration、convert_time、parse_datetime_ns
Chronaxis 用户手册 · 离线阅读