金融科技科学计算【免费下载链接】tf-quant-financeHigh-performance TensorFlow library for quantitative finance.项目地址https://gitcode.com/gh_mirrors/tf/tf-quant-finance点击查看免费下载本篇指南以api_docs/index.mdTF Quant Finance 官方维护的 All symbols in TF Quant Finance 公共 API 符号索引为核心骨架逐一剖析tf_quant_finance命名空间下的八大顶层模块及其全部公开类、函数与子模块并结合仓库源码各模块__init__.py、核心实现文件与模块 README解释每个 API 群的职责与典型用法。读完本文你将能够把符号索引当作导航地图快速定位任意定价函数、模型类或数学工具并理解其在库中的层级归属与底层实现。一、这份文档是什么一份机器生成的完整 API 清单api_docs/index.md是 TF Quant Finance 仓库中的 API 参考索引页其文件头明确标注This file is generated by a tool. Do not edit directly. For open-source contributions the docs will be updated automatically.也就是说它由文档生成工具自动产出最后更新时间为 2023-03-16任何开源贡献提交后文档会被自动刷新。该文件以扁平列表形式列出整个tf_quant_finance命名空间下约 390 个公开符号含嵌套层级每个符号都以a href./tf_quant_finance/xxx.md的形式链接到对应的详细 API 文档页。例如tf_quant_finance根命名空间tf_quant_finance.black_scholes.option_pricetf_quant_finance.models.heston.approximations.european_option_pricetf_quant_finance.experimental.american_option_pricing.andersen_lake.exercise_boundary.cubic_interpolation因此该索引的实战价值在于它是一张符号 → 详细文档的导航地图。当你从库中遇到一个不认识的 API 时可以反向在该索引中检索其所属模块与子模块层级再跳转到对应的 API 文档页查看完整的参数签名、默认值与示例代码。二、顶层模块总览八个命名空间构成的三层体系从 根入口源码 与索引页可见tf_quant_finance顶层只公开八个模块顶层模块官方描述来自 api_docs源码入口black_scholesTensorFlow Quantitative Finance volatility surfaces and vanilla options波动率曲面与香草期权tf_quant_finance/black_scholes/init.pydatetimeDate-related utilities日期相关工具tf_quant_finance/datetime/init.pymathTensorFlow Quantitative Finance general math functions通用数学函数tf_quant_finance/math/init.pymodelsTools to build Diffusion Models扩散模型构建工具tf_quant_finance/models/init.pyratesFunctions to handle rates利率处理函数tf_quant_finance/rates/init.pytypesTypes module类型别名模块tf_quant_finance/types/init.pyutilsUtilities module工具函数模块tf_quant_finance/utils/init.pyexperimentalExperimental modules实验性模块tf_quant_finance/experimental/init.py其中experimental在 根入口 中被try/except ImportError包裹——若构建规则未包含该模块则静默忽略其余七个模块为强制导入。从 项目 README 可知整个库按三层组织基础数学方法优化、插值、求根、线性代数、随机/拟随机数生成等、中层方法ODE/PDE 求解器、Ito 过程框架、扩散路径生成器等、定价方法与量化金融专用工具LV/SV/SLV/Hull-White 等定价模型及校准、利率曲线构建、支付条款描述、日程生成。索引页中的模块层级恰好对应这三层结构。三、black_scholes波动率曲面与香草期权定价模块文档页api_docs/tf_quant_finance/black_scholes.md将其定义为 volatility surfaces and vanilla options。3.1 函数族13 个公开函数函数职责option_price批量计算欧式看涨/看跌期权 Black-Scholes 价格option_price_binomial基于 CRR 二叉树批量计算欧式/美式期权 BS 价格asian_option_price批量计算亚式期权 BS 价格barrier_price在 BS 模型下为障碍期权定价binary_price批量计算二元数字看涨/看跌期权价格asset_or_nothing_price批量计算资产或全无期权价格swaption_price使用 Black 模型计算欧式利率互换期权Swaption价格variance_swap_fair_strike计算方差互换合约的公平执行价brownian_bridge_single/brownian_bridge_double计算一维布朗桥不触碰单/双障碍的概率implied_vol在 BS 模型下求隐含波动率implied_vol_approx使用 Stefanica-Radiocic 算法近似隐含波动率implied_vol_newton从期权价格经 Newton 求根法计算隐含波动率3.2 类与枚举AveragingFrequency/AveragingType亚式期权的平均频率与平均类型ImpliedVolMethod隐含波动率计算方法源码 implied_vol_lib.py 定义为FAST_APPROX快速近似与NEWTONNewton 求根精确值两种ImpliedVolUnderlyingDistribution标的收益分布假设对数正态/正态。3.3 源码级验证批量定价的参数设计以最常用的option_price为例其实现位于 vanilla_prices.py签名如下tff.black_scholes.option_price( *, volatilities, strikes, expiries, spotsNone, forwardsNone, discount_ratesNone, dividend_ratesNone, discount_factorsNone, is_call_optionsNone, is_normal_volatilityFalse, dtypeNone, nameNone)关键约束对应索引页中该符号文档的 Args/Raises 说明spots与forwards二选一且必须提供一个同时给出会抛ValueErrordiscount_rates按 e^(-rT) 计算折现与discount_factors直接给定折现因子互斥同时给出同样抛ValueError全部输入支持 TensorFlow 广播语义例如单个标量expiries 1.0会自动广播到一批 [5] 个期权is_normal_volatilityFalse表示对数正态lognormalBlack 波动率True表示正态波动率。其文档自带的 5 只期权示例可直接运行并得到预期输出[ 0. 2. 2.04806848 1.00020297 2.07303131]验证批量定价与自动广播行为。模块内还包含approximations子模块api_docs提供adesi_whaley美式期权 Adesi-Whaley 近似与bjerksund_stenslandBjerksund-Stensland 近似两个美式期权定价近似算法。四、datetime日期与时间工具模块文档api_docs/tf_quant_finance/datetime.md与子模块 READMEtf_quant_finance/datetime/README.md将该模块描述为基于 TensorFlow 的日期与时间数据结构与工具实现目前只支持日期时间部分留待未来补充。它按三层组织4.1 第一层DateTensor与PeriodTensorDateTensor行为与普通 TensorFlow 张量几乎一致的日期张量底层用 TF 张量承载因此日期操作可直接融入 TF graph支持切片date_tensor[2:5]、expand_dims(axis2)等数组操作多张量操作以类方法形式提供如DateTensor.concat([...], axis-1)PeriodTensor时间周期张量可通过months()、days()等方法构造对应periods子模块的day/days/month/months/week/weeks/year/years八个构造函数。创建DateTensor的入口是dates_from_***家族全部在索引中出现dates_from_datetimes、dates_from_np_datetimes、dates_from_ordinals、dates_from_tensor、dates_from_tuples、dates_from_year_month_day外加convert_to_date_tensor尽力把各种输入转成DateTensor与random_dates在起止日期之间生成随机日期。4.2 第二层HolidayCalendar与营业日概念HolidayCalendar营业日历抽象通过create_holiday_calendar指定周末模式与假日列表来构建仓库不内置各国假日表README 提示可用 Pandas 构造BusinessDayConvention假日滚动约定BusinessDaySchedule生成一个区间内全部营业日组成的日程PeriodicSchedule按固定周期规则生成日期数组配套枚举Month一月为 1、WeekDay周一为 0、WeekendMask常见周末模式的掩码、PeriodType可加减于DateTensor的周期类型。4.3 第三层工具日期数学工具utils子模块is_leap_year、leap_days_between、days_in_leap_years_between、days_in_leap_and_nonleap_years_between、ordinal_to_year_month_day、year_month_day_to_ordinal五种计息日惯例day count conventiondaycount_actual_360、daycount_actual_365_actual、daycount_actual_365_fixed、daycount_actual_actual_isda、daycount_thirty_360_isda均用于计算两个日期之间的年化分数year fraction。五、math通用数学方法工具箱模块文档api_docs/tf_quant_finance/math.md将其定位为构建量化金融模型时常用的数学任务操作并明确说明不追求穷尽覆盖——TensorFlow 与 TensorFlow Probability 已提供大量方法本模块在其之上补充金融场景常用件见 tf_quant_finance/math/README.md。5.1 顶层梯度/雅可比函数索引中的顶层函数共 7 个diff数组元素差分、fwd_gradient前向模式梯度、gradients对*xs求梯度、jacobian对x求雅可比、make_val_and_grad_fn同时计算值与梯度的装饰器、value_and_gradient、value_and_jacobian。它们在 tf_quant_finance/math/gradient.py 与 jacobian.py 中实现前向模式梯度尤其适合参数数量远大于输出数量的金融校准场景。5.2 十一个子模块子模块公开符号来自索引说明integrationIntegrationMethod、integrate、gauss_kronrod、gauss_legendre、simpson数值积分方法interpolationcubicBoundaryConditionType、SplineParameters、build_spline、interpolate、linear.interpolate、interpolation_2d.Interpolation2D线性与三次样条插值、二维插值optimizerbfgs_minimize、lbfgs_minimize、conjugate_gradient_minimize含ConjugateGradientParams、differential_evolution_minimize、differential_evolution_one_step、nelder_mead_minimize、nelder_mead_one_step、converged_all、converged_any数值优化前四个直接复用 TFP 优化器共轭梯度为库内实现conjugate_gradient.pypadpad_tensors、pad_date_tensors批量张量填充辅助pdeboundary_conditionsdirichlet、neumann、fd_solverssolve_backward、solve_forward、gridsuniform_grid、log_uniform_grid、rectangular_grid及两个*_with_extra_point变体、steppers见下有限差分 PDE 求解目前仅支持线性二阶 PDEpiecewisePiecewiseConstantFunc、convert_to_tensor_or_func、find_interval_index分段函数工具qmcsobol_sample、digital_net_sample、lattice_rule_sample、random_digital_shift、random_scrambling_matrices、random_scrambling_vectors、scramble_generating_matrices、sobol_generating_matrices、utilsexp2、log2、tent_transform、filter_tensor、get_shapeRandomized Quasi-Monte CarloRQMC支持randommv_normal_sample、uniform、stateless_random_shuffle、RandomType、halton.sample、sobol.sample/sobol.load_data随机/拟随机采样root_searchbrentqBrent 法、newton_rootNewton 求根一维求根segment_opssegment_cumsum、segment_diff数组分段元素操作custom_loops模块为提升性能自定义的循环实现其中 PDE 子模块的steppers尤为丰富索引中列出了10 个时间推进格式explicit、implicit、crank_nicolson、oscillation_damped_crank_nicolson振荡阻尼 Crank-Nicolson、weighted_implicit_explicit、extrapolation、composite_stepper、douglas_adi含multidim_parabolic_equation_stepper多维支撑与parabolic_equation_stepper。这些 stepper 是使用fd_solvers.solve_backward/solve_forward求解 Feynman-Kac 类 PDE 时的时间推进内核对应文件位于 tf_quant_finance/math/pde/steppers/。六、models扩散模型与 Ito 过程模块 READMEtf_quant_finance/models/README.md给出统一框架所有模型派生自ItoProcess用 SDE 描述$$dX_i a_i(t, X) dt \sum_j S_{ij}(t, X) dW_j$$一个最小模型类需实现dim、dtype、name要使用基类提供的sample_pathsEuler 采样还需实现drift_fn与volatility_fn。基类还提供fd_solver_backward用于求解与该 SDE 关联的 Feynman-Kac PDE即带折现项的 Kolmogorov 倒向方程。6.1 类索引中共 10 个ItoProcessIto 过程接口GenericItoProcess由漂移与波动率函数定义的通用 Ito 过程GeometricBrownianMotion/MultivariateGeometricBrownianMotionBS 模型的标的单变量/多变量几何布朗运动JoinedItoProcess带指定时变相关性的 Ito 过程拼接HestonModel分段常数参数的 Heston 模型SabrModelSABR 模型PathScale路径所在尺度、ReturnsType收益过程类型、ValuationMethod估值方法。6.2 八个子模块euler_sampling.sample/milstein_sampling.sampleEuler 与 Milstein 两种扩散路径采样方案cirCirModelCox-Ingersoll-Ross 利率模型hestonHestonModel与calibration其下approximations子模块含asian_option_price、european_option_price、calibrationhjmGaussianHJM、QuasiGaussianHJM、CalibrationResult以及bond_option_price、swaption_price、cap_floor_price、calibration_from_swaptionshull_whiteHullWhiteModel1F、VectorHullWhiteModel、CalibrationResult以及bond_option_price、swaption_price、bermudan_swaption_price、cap_floor_price、calibration_from_swaptions、calibration_from_cap_floorslongstaff_schwartzleast_square_mc、make_basket_put_payoff、make_polynomial_basisLSM 美式期权蒙特卡洛sabrSabrModel与calibrationapproximations子模块含SabrApproximationType、SabrImpliedVolatilityType、european_option_price、implied_volatility、calibration顶层函数realized_volatility逐路径计算总已实现波动率。这些子模块对应的实现文件均可在 tf_quant_finance/models/ 下找到例如 heston_model.py、hull_white/one_factor.py、gaussian_hjm.py。七、rates利率曲线构建与利率分析模块文档api_docs/tf_quant_finance/rates.md将其定位为利率相关常见任务的工具箱涵盖互换/债券的常用定价函数以及利率曲线的构建与插值。7.1 顶层函数与类swap_curve_bootstrap用bootstrap逐点解出法构建零息互换曲线swap_curve_fit用优化全局拟合法构建零息互换曲线SwapCurveBuilderResult互换曲线校准结果数据类定义于 swap_curve_common.py。7.2 五个子模块analyticscashflowspresent_value、pv_from_yields、yields_from_pv、forwardsforward_rates、forward_rates_from_yields、yields_from_forward_rates、swapequity_swap_price、equity_leg_cashflows、ir_swap_price、ir_swap_par_rate_and_annuity、rate_leg_cashflows、swap_priceconstant_fwdinterpolate恒定远期插值forwardsforward_rates_from_yields、yields_from_forward_rates远期与收益率互换计算hagan_westHagan-West 算法bond_curve债券曲线构建返回CurveBuilderResult与monotone_convex子模块interpolate、interpolate_yields、interpolate_forward_rate、diffnelson_seigel_svenssonSvenssonParameters与interpolateNelson-Siegel-Svensson 曲线插值。其实现分布见 tf_quant_finance/rates/例如 swap_curve_bootstrap.py、hagan_west/monotone_convex.py。仓库还提供了端到端的 Swap_Curve_Fitting.ipynb 教学 Notebook。八、types 与 utils类型别名与通用工具8.1 types模块文档api_docs/tf_quant_finance/types.md列出 8 个张量类型别名BoolTensor、ComplexTensor、DateTensor、DoubleTensor、FloatTensor、IntTensor、RealTensor、StringTensor定义于 data_types.py。它们被广泛用于整个库的函数签名标注如option_price中volatilities: types.RealTensor、is_call_options: types.BoolTensor相当于一份轻量级类型契约。8.2 utils6 个通用工具函数tf_quant_finance/utils/init.pybroadcast_tensors/broadcast_common_batch_shape/common_shape批量形状广播与公共形状推导源自 shape_utils.pyget_shape静态形状完整时返回静态形状否则返回动态形状dataclass创建与tf.function兼容的数据类dataclass.pyiterate_nested按深度优先顺序遍历嵌套结构的每个叶子tf_functions.py。这些工具是其他模块实现广播语义与复合结构处理的基础例如option_price中标量自动广播到批形状的行为就依赖这一套广播逻辑。九、experimental研究/实验模块模块文档api_docs/tf_quant_finance/experimental.md明确说明该模块包含进行中研究/实验项目的代码任何方法都不会被导出到主库API 可能随时变化适合关注前沿功能并愿意跟进变更的读者。索引中共列出 7 个子模块american_option_pricingAndersen-Lake 美式期权定价法其中andersen_lake子模块深度嵌套包含andersen_lake、calculate_exercise_boundary、exercise_boundary含boundary_numerator、boundary_denominator、build_spline、cubic_interpolation等、vanilla_prices与commond_plus、d_minus、standard_normal_cdf、machine_eps、divide_with_positive_denominator并依赖math的gauss_kronrod、gauss_legendre与interpolationinstruments利率工具库索引中列出的类多达 20 余个Bond、CapAndFloor、EurodollarFutures、Swaption、OvernightIndexLinkedFutures、ForwardRateAgreement、FloatingRateNote、RateCurve、InterestRateSwap、CMSSwap、CMSCashflowStream、FixedCashflowStream、FloatingCashflowStream以及规格/枚举类FixedCouponSpecs、FloatCouponSpecs、CMSCouponSpecs、AverageType、InterestRateMarket、InterestRateModelType、DayCountConvention和函数ratecurve_from_discounting_functioninstruments/init.pyionumpy 数组字典的序列化/反序列化ArrayDictReader、ArrayDictWriter、encode_array、decode_arraylocal_volatilityLocalVolatilityModel局部波动率模型local_stochastic_volatilityLocalStochasticVolatilityModel与LSVVarianceModel随机局部波动率模型lsm_algorithmLSM 算法least_square_mc与least_square_mc_v2两个版本及make_basket_put_payoff、make_polynomial_basis/make_polynomial_basis_v2sviSVI 波动率模型calibration、implied_volatility_from_raw_svi_parameters、total_variance_from_raw_svi_parameters。从 experimental/init.py 可见除上述之外仓库还包含pricing_platform定价平台框架含 instrument protos 与 market data 组件但索引页中的公开符号清单以模块形式呈现。十、如何从符号索引导航到详细文档索引页中每个符号都是锚点链接指向api_docs/tf_quant_finance/下对应的 Markdown 文档页。导航规则如下模块级页面如 black_scholes.md、math.md按 Modules / Classes / Functions 分节给出每个符号一句话职责描述符号级页面如 option_price.md包含完整函数签名、可运行示例、Args/Returns/Raises 逐项说明与参考文献文档页底部的 View source 链接直接指向仓库中对应的.py实现文件可一步进入源码研读。例如从索引找到tf_quant_finance.black_scholes.option_price→ 打开 option_price.md → 查看签名与示例 → 点击 View source 进入 vanilla_prices.py 阅读实现。十一、环境要求与快速上手结合 README.md 与 setup.py库要求Python 3.7与TensorFlow 2.7根入口 内置了最低版本检查_REQUIRED_TENSORFLOW_VERSION 2.3pip 安装先pip3 install --upgrade tensorflow再pip3 install --upgrade tf-quant-finance必要时加--user开发依赖还包括 TensorFlow Probabilityv0.11.0 ~ v0.12.1、Numpy 1.21、Attrs、Dataclasses构建系统为 Bazel测试可用bazel test tf_quant_finance/math/random_ops/sobol:sobol_test等命令从源码构建自定义 pip 包bazel build :build_pip_pkg后执行./bazel-bin/build_pip_pkg artifacts再pip install --user --upgrade artifacts/*.whl。快速体验入口是 tf_quant_finance/examples/jupyter_notebooks/ 下的 12 个教程 Notebook覆盖本篇文章涉及的主要主题Black_Scholes_Price_and_Implied_Vol.ipynb、American_Option_Black_Scholes.ipynb、Monte_Carlo_Euler_Scheme.ipynb、Dates_in_TFF.ipynb、Root_Search.ipynb、Optimization.ipynb、Swap_Curve_Fitting.ipynb、Forward_Backward_Diff.ipynb、Vectorization_and_XLA_compilation.ipynb以及三个 TensorFlow 基础入门 Notebook。结语api_docs/index.md虽是一份由工具自动生成的符号清单但它是理解 TF Quant Finance 公共 API 全景最权威、最完整的入口八大顶层模块、十余个定价与利率子模块、约 390 个公开符号在此尽收眼底。结合本文的模块地图与源码对应关系你可以快速定位任一功能从批量 BS 定价、隐含波动率求解、Ito 过程采样到利率曲线构建与实验性研究工具并沿文档页的 View source 链接深入底层实现。建议以 black_scholes.md 与 models.md 为起点配合对应 Notebook 实践逐步建立对整个库的完整认知。赞分享金融科技科学计算【免费下载链接】tf-quant-financeHigh-performance TensorFlow library for quantitative finance.项目地址https://gitcode.com/gh_mirrors/tf/tf-quant-finance点击查看免费下载相关推荐Celery API Reference 完全指南公开 API 全景、模块地图与源码级解读Celery API Reference 完全指南公开 API 全景、模块地图与源码级解读 本文以仓库 docs/reference/index.rst ht任务调度后端消息队列vLLM-Omni 公共 API 全景图从入口点到 Worker 的模块化代码地图vLLM Omni 公共 API 全景图从入口点到 Worker 的模块化代码地图 本指南以仓库 docs/api/README.md https://lin人工智能大模型模型推理服务多模态语音音频媒体生成本地部署tf-quant-finance 顶层 API 全景指南从 tf_quant_finance 模块看懂量化金融库的八大功能域tf quant finance 顶层 API 全景指南从 tf_quant_finance 模块看懂量化金融库的八大功能域 导读 本文以 tf quant金融科技科学计算上一篇如何快速掌握IsomerHTML5 Canvas等轴测投影的完整指南下一篇从小程序UI到代码艺术Vant Weapp组件库规范全解析创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考