Skip to main content

xqfactor

xqfactor 是数据源无关、统一使用 pandas.DataFrame 传递因子值的因子表达式、 执行缓存和检验规范框架。

核心包不依赖 xqdata、RQData、数据库或本地数据仓库。应用项目通过 LeafFactor 的 resolver 实现实际取数;xqfactor 负责表达式组合、历史窗口需求、 轴对齐、递归求值和相同执行上下文下的缓存复用。

安装

uv add xqfactor

需要内置统计检验时:

uv add "xqfactor[analysis]"

基本用法

import pandas as pd

from xqfactor import EvaluationContext, LeafFactor, LeafRequest, MemoryCache, RANK


def load_close(request: LeafRequest) -> pd.DataFrame:
    """由应用负责从 API、数据库或本地文件读取数据。"""
    return pd.DataFrame(
        [[1.0, 2.0], [2.0, 1.0]],
        index=request.context.time_index,
        columns=request.context.universe,
    )


CLOSE = LeafFactor("close", load_close)
factor = RANK(CLOSE)
context = EvaluationContext(
    time_index=("2025-01-01", "2025-01-02"),
    universe=("000001.SZ", "000002.SZ"),
    frequency="D",
)
cache = MemoryCache(maxsize=256)
result = factor.evaluate(context, cache)

固定公共类因子

使用 FIX 可以把任意因子表达式固定到指定资产,再广播到当前 universe。固定过程 在只包含目标资产的子上下文中求值,因此不会因为当前研究股票池变化而改变,适合指数或 基准收益等公共类因子。

from xqfactor import FIX, PCT_CHANGE


RETURNS = PCT_CHANGE(CLOSE, 1)
CSI500_RETURNS = FIX(RETURNS, "000985.XSHG")
EXCESS_RETURNS = RETURNS - CSI500_RETURNS

自定义算子

自定义算子分为“与因子无关的 DataFrame 计算函数”和“表达式构造函数”两层:

import pandas as pd

from xqfactor import AbstractFactor, CombinedFactor


def cross_sectional_demean(frame: pd.DataFrame) -> pd.DataFrame:
    """将每个时间截面的值减去截面均值。"""
    return frame.sub(frame.mean(axis=1), axis=0)


def DEMEAN(factor: AbstractFactor) -> CombinedFactor:
    """把横截面去均值逻辑应用到任意因子。"""
    return CombinedFactor(cross_sectional_demean, factor)

职责边界

  • 本项目负责因子表达式图、Pandas/NumPy 基础算子、显式执行上下文和内存执行缓存。
  • 具体基础因子、在线 API、DolphinDB、Parquet、DuckDB 和全量市场数据由应用项目负责。
  • 执行缓存只复用完全相同上下文下的叶子数据和中间因子,不是本地数据仓库。
  • Polars、PyTorch 等库可在某个自定义算子内部按需使用,但不形成独立计算后端。
  • 标准化、去极值和中性化等预处理使用因子算子表达;检验器只负责统计分析。

代码阅读路径

从应用创建 LeafFactor 开始,resolver 根据 LeafRequest 返回二维 DataFrame; operators.py 和应用自定义构造函数把基础因子组合成表达式图; factor.evaluate() 递归查询 MemoryCache、计算子节点并统一对齐时间轴和资产轴, 最后按 EvaluationContext 截取输出区间。检验流程从 analysis/base.pyAbstractAnalyzer.analyze() 开始,将因子表达式和检验器附加输入 统一求值后,交给 ic.pyquantile_return.pyregression.py 中的具体检验器统计。

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xqfactor-0.2.1.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xqfactor-0.2.1-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file xqfactor-0.2.1.tar.gz.

File metadata

  • Download URL: xqfactor-0.2.1.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for xqfactor-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e3d1e4970a8a75b39f5e5b3c6bd0295ffa8de15a8f80004aa9253e6f1d67b52d
MD5 5c5ba61d168953fea5c238750f0a8ed4
BLAKE2b-256 81ebfcf3d7f1b1327354c7e3843ee3822cdfdc21e74ba003a5babf69b52916e1

See more details on using hashes here.

File details

Details for the file xqfactor-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: xqfactor-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for xqfactor-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab4a08ccd29c4a81974db2fe57d2e71d181a616e0a1950594e733e06b037941e
MD5 65d5a44e5e85b12580bc3083c7edfd4b
BLAKE2b-256 f7bf8038c6061a90a1c50a83b508a521ca90eb6a09f12495ab0c1ff0dfdc8a53

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.0

2 files

0.3.0

2 files

0.2.2

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page