Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

CmdStan guide lacks doc on columns of `diagnose` output

未关闭
#666 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
55/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
tex
领域
documentation

调研方向

打开关于通过比较梯度诊断 HMC 的 CmdStan 指南页面,并查看文档中记录的 diagnose 输出。为每个输出列添加说明,尤其是 param_idx 和 value,然后验证该指南是否能让人无需猜测就理解此表格。

由索引模型根据 Issue 内容生成。

描述

This came up in cmdstanr issue #826 from @ksvanhorn:

It's worth noting the the columns in the output aren't documented anywhere that I can find. I can guess what some of them are, but what are "param idx" and "value"?

One other note: it seems that the diagnose operation failed with a return code of 1, but none of the information I was able to gather told me why the program failed. I'm guessing that maybe an exception got thrown while evaluating an extremely large gradient, but it would be useful for the program to say more instead of just returning an error code of 1.

If I go to the CmdStan doc for the diagnose method I see that @ksvanhorn is right and the columns of the output have no explanations (although some are self explanatory, others could be a bit confusing, like param_idx).

主要语言
TeX
星标
43
派生
133
平均合并
11 小时 32 分钟
30 天内合并 PR
4

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

stan-dev/docs 的其他 Issue

查看 stan-dev/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。