出力行メタデータ

Code Respository Transforms で、出力データセットの行の説明と行タイプクラスを読み取りおよび書き込むことができます。

Code Repository Transforms での行説明の更新

出力データセットに出力行の説明を追加するには、TransformOutput の write_dataframe() 関数に、オプションの column_descriptions 引数を提供します。

• この引数は、行名のキーと行説明の値を持つ dict である必要があります。行説明の長さは800文字までです。
• コードは、ユーザーの DataFrame で利用可能な行名と、提供された dict のキーとの間の交差点を自動的に計算するため、存在しない行に説明を付けようとはしません。

例: Code Repository Transforms で行説明を書き込む

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from transforms.api import transform, Input, Output

# transform, Input, Output をtransforms.apiからインポートします。

@transform(
    my_output=Output("/my/output"),
    my_input=Input("/my/input"),
)
# transformデコレーターを使用して、入力と出力を設定します。

def my_compute_function(my_input, my_output):
# my_compute_function関数を定義します。この関数はmy_inputを受け取り、my_outputに結果を書き込みます。

    my_output.write_dataframe(
        my_input.dataframe(),
        column_descriptions={
            "col_1": "col 1 description"
        }
    )
    # my_inputからデータフレームを取得し、それをmy_outputに書き込みます。
    # column_descriptionsは、各列の説明を提供します。ここでは、"col_1"の説明として"col 1 description"が設定されています。

行タイプクラス

column_typeclasses プロパティは、行名をその行タイプクラスにマッピングする構造化された Dict<str, List<Dict<str, str>>> を返します。

• List の中の各タイプクラスは Dict[str, str] オブジェクトです。
  • この Dict オブジェクトは、キーとして "name" と "kind" のみを使用しなければなりません。これらのキーのそれぞれは、ユーザーが望む対応する文字列にマッピングします。

column_typeclasses の値の例は、{"my_column": [{"name": "my_typeclass_name", "kind": "my_typeclass_kind"}]} になります。

例：コードリポジトリ変換で行の説明とタイプクラスを読み書きする

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from transforms.api import transform, Input, Output


@transform(
    # 出力データセットの指定
    my_output=Output("ri.foundry.main.dataset.my-output-dataset"),
    # 入力データセットの指定
    my_input=Input("ri.foundry.main.dataset.my-input-dataset"),
)
def my_compute_function(my_input, my_output):
    # 最近の10レコードを取得
    recent = my_input.dataframe().limit(10)

    # 既存のタイプクラスを取得
    existing_typeclasses = my_input.column_typeclasses
    # 既存の列の説明を取得
    existing_descriptions = my_input.column_descriptions

    # 取得したデータフレームを出力データセットに書き込む
    my_output.write_dataframe(
        recent,
        column_descriptions=existing_descriptions,
        column_typeclasses=existing_typeclasses
    )