document approach to accuracy

オープン 初心者向け
#134 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
62/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
julia
領域
documentation

調査の方向性

issue #45の最近の議論を読み、issue #134で提案されている精度に関するガイダンスと比較してください。パッケージのドキュメントのエントリーポイントを見つけ、列挙された精度目標、汎用フォールバック、メソッドのdocstring、より高い精度を要求する方法を網羅した簡潔な説明を追加してください。このガイダンスが議論と一貫性のある形で文書化されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Following up on the recent discussion at #45, we should perhaps consider documenting the package's approach to accuracy.

I would say roughly this:

  1. We aim for accurate implementations of at least Float64 inputs. "Accurate" is determined as a practical trade-off.
  2. Most methods have ::Float32 and ::Float16 implementations, with similar aims.
  3. All methods have a generic fallback, which may not be as accurate but should not produce wildly incorrect results.
  4. Docstrings should document more specific claims for each method.
  5. If more accuracy is needed, please open an issue.
主要言語
Julia
スター
86
フォーク
25
平均マージ
3日 10時間
マージ済み PR(30日)
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

JuliaStats/LogExpFunctions.jl のほかの issue

JuliaStats/LogExpFunctions.jl の issue をすべて見る

似ている issue

Julia の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。