Skip to content

feat: add Histogram API reference - #390

Merged
Nexisato merged 11 commits into
mainfrom
feat/histogram-api-docs
Nov 10, 2026
Merged

Nexisato merged 11 commits into
mainfrom
feat/histogram-api-docs

Conversation

@Ji11

@Ji11 Ji11 commented Nov 5, 2026

Copy link
Copy Markdown
Member

变更内容

新增 swanlab.Histogram 中英文 API 文档,介绍原始样本与预分桶输入、参数优先级、桶数和边界限制、异常行为,以及 NumPy、PyTorch 使用示例。

补充 API 索引、log 页面和侧边栏入口。

新增 Histogram 中英文 API 文档,说明参数、分桶规则、数据校验及 NumPy、PyTorch 使用示例。
补充 API 索引、log 页面和侧边栏入口。
@Ji11
Ji11 requested a review from Nexisato November 5, 2026 10:56
直方图页面更新三处描述:

- PyTorch Tensor 可直接传入 sequence,SDK 自动执行 detach().cpu() 转换,
  GPU、带梯度与 bfloat16 精度均受支持,示例代码改为直接传入
  layer.weight.flatten()
- num_bins 经由关键字参数接收,仅在 bins 未指定时生效,两者同时给出时
  以 bins 为准并产生警告,其余未识别的关键字参数会被忽略
- 类型与形状错误的输入在构造时不再抛出异常,SDK 打印警告并将实例标记
  为无效,swanlab.log() 记录时跳过该条指标;数值与参数组合错误仍然
  抛出 ValueError;属性表新增 is_valid
@Ji11
Ji11 marked this pull request as draft November 6, 2026 03:22
@Ji11
Ji11 marked this pull request as ready for review November 6, 2026 03:23
@Nexisato
Nexisato merged commit e4bbbb1 into main Nov 10, 2026
1 check passed
@Nexisato
Nexisato deleted the feat/histogram-api-docs branch November 10, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants