FluxML/Flux.jl

Provide aliases for unicode fields and keywords

Open

#503 opened on 2018年11月21日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Julia (4,725 stars) (619 forks)batch import
good first issuehelp wanted

説明

I'm thinking of adding aliases for keyword arguments and structure fields that currently require using unicode characters to access. Examples include the σ in the Conv field names, and almost all of the fields in BatchNorm:

julia> fieldnames(BatchNorm)
(:λ, :β, :γ, :μ, :σ, :ϵ, :momentum, :active)

I only have three data points so far, but when other people start to use Flux this has been something that bothers them.

Questions:

  • Is this something we should do?
  • Would you prefer having ascii names added as aliases, or replacing the current instances of unicode with ascii names and then adding the current unicode names back as aliases?
  • Should the ascii name simply spell out the unicode symbol, or describe meaning of the field/variable? For example, should the alias for σ in Conv be activation or sigma? (My preference would be activation.)

コントリビューターガイド

技術スタック
なし
領域
machine learning
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Familiarity with Flux.jlBasic Julia syntax
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
The issue proposes adding ASCII aliases for unicode field names in Flux, specifically for Conv and BatchNorm layers. Look at the current implementations of these layers in the source code (likely in src/layers/conv.jl and src/layers/normalise.jl) to understand the existing field names. The maintainer prefers descriptive aliases like 'activation' over 'sigma'. Newcomers can implement aliases by defining methods like `getproperty` or using the `@kwdef` macro with aliases. Check the existing discussion for further guidance.