Revisit Multi-Output Support Naming Conventions

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
julia

調査の方向性

まず PR #310 の議論とリンク先のスレッドを読み、次に src/mokernels/slfm.jl、特に composite type のフィールドを調べてください。プロジェクトに multi-output 型、helper、フィールド、および LinearMixingModelKernel に関する文書化され合意された命名規則ができたら、作業は完了です。

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

説明

Two new multi-output input types are being added and the PR sparked some debate/discussion surrounding their names and the wider spread naming conventions that have been adopted in KernelFuntions. The main thread discussing these can be found [here].(https://github.com/JuliaGaussianProcesses/KernelFunctions.jl/pull/310#discussion_r661490968).

Some starting points:

  • MO vs MultiOutput. Concise or explicit?
  • Do we like the prefix isotopic? Is it too jargony?

Quote from paper linked above:
In the geostatistics literature, if each output has the same set of inputs the model
is called isotopic

Pros:
It has a specific meaning in this context, clearly identifying what it is
Cons:
Might scare users off, lengthens names

  • Relating to the PR linked above, how do we make these accessible? Less "wordy" helpers? What do we call those?
  • Should composite type field names have more descriptive names?
    eg. kernels, mokernel and weights instead of g, e and A for the slfm
  • the LinearMixingModelKernel is a kernel, not a model. Maybe it should be renamed LinearMixingKernel for eg. I think we've all agreed on this already.
主要言語
Julia
スター
276
フォーク
42
平均マージ
3日 12時間
マージ済み PR(30日)
2

環境構築

はじめの一歩

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

JuliaGaussianProcesses/KernelFunctions.jl のほかの issue

JuliaGaussianProcesses/KernelFunctions.jl の issue をすべて見る

似ている issue

Julia の issue をもっと見る

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

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