皆さんはdataikuのフロー整理の際、下図の例(画像はalteryxというETLツールのもの)のように、レシピごとに注釈を残したいと思ったことはありませんか。
今回は、dataikuでも同様にレシピごとに注釈を残す方法についてご紹介します!
はじめに、dataikuのドキュメンテーション機能について
dataikuでは一般的にドキュメンテーションの方法として、「Wiki」というフローとは別タブで、フローについての説明を記述する方法が紹介されることが多いと思います。
ただし、フローの中の各レシピに注釈書きやメモなどをしていきたい人も多いのではないでしょうか。(私がその一人)
実はdataikuにも同様の機能が存在します!ただし、現時点ではマウスオーバーしないと注釈が表示されず、そこは少々不便だと感じます。
フロー内のレシピへ注釈を記載する方法
以下、実際にフロー内のレシピに注釈を付与する方法を説明します。
①注釈を追加したい任意のレシピを選択し、続けてフロー右側の「詳細」(「i」のマーク)を選択し、「編集」をクリックしてください。
②このようなウィンドウが立ち上がりますので、ここで「short description」に説明を記載して「save」を押します。
③注釈を付与したレシピにはこのように「i」のアイコンがつき、該当のレシピをマウスオーバーすると先ほど記述した説明書きが表示されます。
以上、レシピに注釈を付与する方法のご説明でした!ちなみにレシピだけではなくデータセットに対しても同様に注釈を付与できます。
先にも述べたとおり、alteryxなどのように注釈がフロー上に常時表示されず、あくまでも各レシピに「i」のアイコンが示されるだけでマウスオーバーしないと詳細が確認できない点は不便であると感じます。
しかし、各レシピでどのような処理をしているのか作業のメモとしての機能は十分果たせると思うので、是非みなさんも活用してみてください!