Skip to content

feat: update function docs #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

feat: update function docs #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
39c15c8
.
imos Jul 2, 2025
ef38e14
.
imos Jul 2, 2025
452ee34
.
imos Jul 2, 2025
cca24db
.
imos Jul 2, 2025
3f9abea
.
imos Jul 2, 2025
9e08f2c
.
imos Jul 3, 2025
f495448
.
imos Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/locale/ja/LC_MESSAGES/api/modules.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.apply_for_axis.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -62,7 +61,6 @@ msgid ""
msgstr "関数を適用する次元。デフォルトは -1 で、最後の次元を指定します。"

#: ../../api/qfeval_functions.functions.apply_for_axis.rst
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.bfill.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -51,7 +50,6 @@ msgid ""
msgstr "後方補完を実行する次元。デフォルトは -1 で、最後の次元を指定します。"

#: of qfeval_functions.functions.bfill.bfill
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
3 changes: 0 additions & 3 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.bincount.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -59,7 +58,6 @@ msgid ""
msgstr "カウントする次元。デフォルトは -1 で、最後の次元を意味します。"

#: of qfeval_functions.functions.bincount.bincount
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand All @@ -75,7 +73,6 @@ msgid "Return type"
msgstr "戻り値の型"

#: of qfeval_functions.functions.bincount.bincount:29
#, fuzzy
msgid "Example"
msgstr "使用例"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.bollinger_band.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -64,7 +63,6 @@ msgid ""
msgstr "ボリンジャーバンドを計算する次元。デフォルトは-1（最後の次元）です。"

#: of qfeval_functions.functions.bollinger_band.bollinger_band
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
3 changes: 0 additions & 3 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.correl.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.correl"
msgstr "qfeval\\_functions.functions.correl"

#: of qfeval_functions.functions.correl.correl:1
#, fuzzy
msgid "Compute Pearson correlation coefficient between two tensors."
msgstr "`x`と`y`の間のピアソン相関係数を返します。"

Expand Down Expand Up @@ -64,7 +62,6 @@ msgid ""
msgstr "出力テンソルが :attr:`dim` を保持するかどうか。デフォルトは False。"

#: of qfeval_functions.functions.correl.correl
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
3 changes: 0 additions & 3 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.covar.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.covar"
msgstr "qfeval\\_functions.functions.covar"

#: of qfeval_functions.functions.covar.covar:1
#, fuzzy
msgid "Compute covariance between two tensors along a specified dimension."
msgstr "指定された次元に沿って、与えられたテンソル間の共分散を計算します。"

Expand Down Expand Up @@ -95,7 +93,6 @@ msgid ""
msgstr "自由度の差分。計算に使用される除数は ``N - ddof`` で、ここで ``N`` は要素数を表します。デフォルト値は 1 です。"

#: of qfeval_functions.functions.covar.covar
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.cumcount.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -51,7 +50,6 @@ msgid ""
msgstr "累積カウントを実行する次元。デフォルトは-1（最後の次元）です。"

#: of qfeval_functions.functions.cumcount.cumcount
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
4 changes: 0 additions & 4 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.eigh.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.eigh"
msgstr "qfeval\\_functions.functions.eigh"

#: of qfeval_functions.functions.eigh.eigh:1
#, fuzzy
msgid "Compute eigenvalues and eigenvectors of a symmetric/Hermitian matrix."
msgstr "固有値と固有ベクトルを計算します。"

Expand All @@ -38,7 +36,6 @@ msgid ""
msgstr "この関数は、実対称行列または複素エルミート行列の固有値と固有ベクトルを計算します。固有値は昇順に返され、対応する固有ベクトルは正規化されます。この実装では、CPUテンソルにはNumPyを、CUDAテンソルにはCuPyを使用しています。"

#: of qfeval_functions.functions.eigh.eigh:9
#, fuzzy
msgid "This function does not support automatic differentiation (autograd)."
msgstr "注意: この関数は微分可能な計算をサポートしていません。"

Expand Down Expand Up @@ -73,7 +70,6 @@ msgid "'U' or 'u': Use the upper triangular part"
msgstr "'U' または 'u': 上三角部分を使用する"

#: of qfeval_functions.functions.eigh.eigh
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.einsum.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -57,7 +56,6 @@ msgid ""
msgstr "演算対象の入力テンソル。演算子の数は方程式中のカンマ区切りグループの数と一致している必要があります。"

#: of qfeval_functions.functions.einsum.einsum
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.ema.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -77,7 +76,6 @@ msgid ""
msgstr "指数移動平均を計算する次元。デフォルトは -1 で、最後の次元を意味します。"

#: ../../api/qfeval_functions.functions.ema.rst
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.ffill.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -53,7 +52,6 @@ msgid ""
msgstr "順方向フィルを実行する次元。デフォルトは -1 で、最後の次元を指定します。"

#: of qfeval_functions.functions.ffill.ffill
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
3 changes: 0 additions & 3 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.fillna.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.fillna"
msgstr "qfeval\\_functions.functions.fillna"

#: of qfeval_functions.functions.fillna.fillna:1
#, fuzzy
msgid "Replace NaN and infinity values with specified numbers."
msgstr "NaN、正の無限大、負の無限大の値を指定した数値に置換します。"

Expand Down Expand Up @@ -64,7 +62,6 @@ msgid ""
msgstr "負の無限大を置き換える値。デフォルトは ``-math.inf`` で、負の無限大をそのまま保持します。"

#: of qfeval_functions.functions.fillna.fillna
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
2 changes: 0 additions & 2 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.gaussian_blur.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -67,7 +66,6 @@ msgid ""
msgstr "ガウシアンブラーを適用する次元。デフォルトは -1 で、最後の次元を指定します。"

#: ../../api/qfeval_functions.functions.gaussian_blur.rst
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
4 changes: 0 additions & 4 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.group_shift.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.group\\_shift"
msgstr "qfeval\\_functions.functions.group\\_shift"

#: of qfeval_functions.functions.group_shift.group_shift:1
#, fuzzy
msgid "Shift tensor elements along a dimension, skipping masked positions."
msgstr "指定された次元に沿ってテンソルをシフトし、指定されたマスクの位置はスキップします。"

Expand Down Expand Up @@ -57,7 +55,6 @@ msgid "Parameters"
msgstr "パラメータ"

#: of qfeval_functions.functions.group_shift.group_shift:20
#, fuzzy
msgid "The input tensor to be shifted."
msgstr "入力テンソル。"

Expand All @@ -68,7 +65,6 @@ msgid ""
msgstr "シフトする位置の数。正の値は前方へシフト（高いインデックス方向へ）、負の値は後方へシフトします。デフォルト値は1です。"

#: of qfeval_functions.functions.group_shift.group_shift:28
#, fuzzy
msgid "The dimension along which to perform the shift. Default is 0."
msgstr "`x` がシフトされる次元。"

Expand Down
3 changes: 0 additions & 3 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.groupby.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
Expand Down Expand Up @@ -37,7 +36,6 @@ msgid ""
msgstr "この関数は、与えられたグループ識別子に基づいてテンソルの要素をグループに再編成します。各グループに属するすべての要素を含む新しい次元を作成します。これはSQLのGROUP BY句やpandasのgroupby操作に似ていますが、テンソル演算用に最適化されています。"

#: of qfeval_functions.functions.groupby.groupby:8
#, fuzzy
msgid ""
"The function adds a new dimension immediately after the specified "
"dimension. This new dimension represents the items within each group. "
Expand Down Expand Up @@ -77,7 +75,6 @@ msgid ""
msgstr "グループサイズの最大値よりも要素数が少ないグループをパディングするために使用される値。デフォルトは ``nan`` です。"

#: of qfeval_functions.functions.groupby.groupby
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand Down
23 changes: 14 additions & 9 deletions docs/locale/ja/LC_MESSAGES/api/qfeval_functions.functions.ma.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
# package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: qfeval-functions \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-06-28 00:58+0900\n"
"POT-Creation-Date: 2025-07-03 02:53+0900\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: ja\n"
Expand All @@ -25,7 +24,6 @@ msgid "qfeval\\_functions.functions.ma"
msgstr "qfeval\\_functions.functions.ma"

#: of qfeval_functions.functions.ma.ma:1
#, fuzzy
msgid "Compute the moving (sliding window) average of a tensor."
msgstr "指定されたテンソルの移動平均を返します。"

Expand All @@ -36,7 +34,10 @@ msgid ""
" the same shape as the input tensor. For positions where the sliding "
"window cannot fully cover preceding elements (i.e., the first ``span - "
"1`` elements along the selected dimension), the result is ``nan``."
msgstr "この関数は、指定された次元に沿ってサイズ :attr:`span` のスライディングウィンドウ内の要素の平均値を計算します。出力テンソルの形状は入力テンソルと同じです。スライディングウィンドウが直前の要素を完全にカバーできない場合（すなわち、指定された次元に沿って最初の ``span - 1`` 要素の場合）、結果は ``nan`` となります。"
msgstr ""
"この関数は、指定された次元に沿ってサイズ :attr:`span` "
"のスライディングウィンドウ内の要素の平均値を計算します。出力テンソルの形状は入力テンソルと同じです。スライディングウィンドウが直前の要素を完全にカバーできない場合（すなわち、指定された次元に沿って最初の"
" ``span - 1`` 要素の場合）、結果は ``nan`` となります。"

#: of qfeval_functions.functions.ma.ma:9
msgid "The moving average is computed as:"
Expand All @@ -47,7 +48,10 @@ msgid ""
"\\text{MA}[i] = \\frac{1}{\\text{span}} \\sum_{j=i-\\text{span}+1}^{i} "
"x[j]\n"
"\n"
msgstr "\\text{MA}[i] = \\frac{1}{\\text{span}} \\sum_{j=i-\\text{span}+1}^{i} x[j]\n\n"
msgstr ""
"\\text{MA}[i] = \\frac{1}{\\text{span}} \\sum_{j=i-\\text{span}+1}^{i} "
"x[j]\n"
"\n"

#: of qfeval_functions.functions.ma.ma:14
msgid ""
Expand All @@ -74,7 +78,6 @@ msgid ""
msgstr "移動平均を計算する次元。デフォルトは -1 で、最後の次元を意味します。"

#: ../../api/qfeval_functions.functions.ma.rst
#, fuzzy
msgid "Returns"
msgstr "戻り値の型"

Expand All @@ -94,9 +97,11 @@ msgid "Example"
msgstr "使用例"

#: of qfeval_functions.functions.ma.ma:61
msgid ""
":func:`msum`: The underlying moving sum function. :func:`ema`: "
"Exponential moving average for weighted averaging."
msgid ":func:`msum`: The underlying moving sum function."
msgstr ":func:`msum`: 移動合計を計算する基礎関数。 :func:`ema`: 加重平均を計算するための指数移動平均。"

#: of qfeval_functions.functions.ma.ma:62
msgid ":func:`ema`: Exponential moving average for weighted averaging."
msgstr ":func:`msum`: 移動合計を計算する基礎関数。 :func:`ema`: 加重平均を計算するための指数移動平均。"

#~ msgid ":sphinx_autodoc_typehints_type:`\\:py\\:class\\:\\`\\~torch.Tensor\\``"
Expand Down
Loading
Loading