カスタムオペレータ

このページでは、Python LearnerおよびPython Transformerオペレータを使用してカスタムオペレータを作成することで、PythonコードをRapidMinerプロセスにさらに埋め込む方法を説明します。このカスタムオペレータは、Pythonに詳しくない人とも共有することができます。

Python Learnerオペレータ

Python Learnerでは、RapidMinerのモデルインタフェースと互換性のある、Pythonベースのモデルを作成することができます。Python Learner（およびそこから派生したカスタムオペレータ）を使って作成したモデルは、Apply Modelオペレータを使用してモデルの適用や、RapidMinerのCross-Validationオペレータを使用してモデルの学習、Optimizeオペレータを使用して調整できたりと、様々なことができます。

RapidMiner Studioのオペレータパネルから新しいPython Learnerをキャンバスにドラッグすると、（オペレータの色や入出力ポートなどの点で）他の学習モデルと似たオペレータが表示されます。また、あらかじめいくつかのパラメータが設定されており、それらを編集することができます。サポートされているパラメータタイプの一覧は以下の通りです。

オペレータの情報パネルには、このPythonベースの学習モデルの機能も表示されています。

パラメータの定義や機能を編集するには、パラメータパネルの歯車アイコンをクリックします。JSONエディタが表示され、これらを追加・変更することができます。ここに書いたJSONは検証され、何かが間違っている場合は警告が表示されます。誤った設定を適用すると、キャンバス上のオペレータから入力ポートが消えてしまいます。

Python Learnerを実装するには、rm_trainとrm_applyの2つの関数を定義する必要があります。名前が示すように、最初のものは、Python Learnerオペレータでモデルを学習させるときに実行されます。2つ目は、Python Learnerで作成したモデルをApply Modelなどで適用する際に実行されます。これらの機能を実装するためのヒントは、提供されているチュートリアルプロセスを参照することをお勧めします。

Python Learnerオペレータは現在、予測モデル(forecasting models)をサポートしていません。

Python Transformerオペレータ

Python Transformerは、ユーザーが定義したパラメータと入出力ポートを持つExecute Pythonオペレータと捉えることができます。

オペレータの名前やパラメータ名、タイプ、デフォルト値、入力ポートと出力ポートは、オペレータのパラメータパネルで歯車のアイコンをクリックし、ポップアップエディタでJSON定義を編集して定義します。これは、上で説明したPython Learnerオペレータのものとよく似ています（Transformerは機能のリストを持ちませんが、入力と出力を必要とします）。ここに書いたJSONは検証され、何かが間違っている場合は警告が表示されます。誤った設定を適用すると、キャンバス上のオペレータから入力ポートが消えてしまいます。サポートされているパラメータタイプの一覧は以下の通りです。

コードを期待通りに実行するためには、Execute Pythonと同じ規則に従わなければなりません。メインのエントリーポイントはrm_main関数で、関数のパラメータと戻り値の数と順序は、オペレータの入力ポートと出力ポートに対応しています。

Python Transformerベースのカスタムオペレータに複数の入力と出力が必要な場合は、JSON定義の inputs と outputs の部分を使用して明示的に定義する必要があります。Execute Pythonの動的なポートに慣れているユーザーは、直感的でないと感じるかもしれません。

新しいPython Transformerをキャンバスにドラッグしたときに表示されるパラメータ設定とコードのサンプルには、上記のヒントがすべて含まれています。

サポートされているパラメータタイプ

ここでは、 Python Learner と Python Transformerでサポートされているパラメータタイプのリストを紹介しています。これらは、オペレータのパラメータ設定を行うJSONのパラメータリストで使用できます。

各パラメータ定義には以下の属性があり、パラメータを記述するタプルの中ではキーと値のペアで表現されます。

ここでは、上記のパラメータの定義に対するいくつかの例を紹介します。

"parameters": [
 {
  "name": "1st_parameter",
  "type": "string",
  "optional": true
 },
 {
  "name": "2nd_parameter",
  "type": "integer",
  "value": 100
 },
 {
  "name": "3rd_parameter",
  "type": "category",
  "categories": [
    "Category A",
    "Category B",
    "Category C",
    "Default Category"
  ],
  "value": "Default Category"
 },
 {
  "name": "4th_parameter",
  "type": "boolean"
 },
 {
  "name": "5th_parameter",
  "type": "real",
  "value": 3.1415
 },
 {
  "name": "6th_parameter",
  "type": "string",
  "optional": true
 }
]

カスタムPythonオペレータでの環境の扱い

Execute Pythonオペレータと同様に、use default Pythonパラメータのチェックを外して、使用する環境を指定することができます。Python Learnerの場合、モデルが適用される際も学習に使用したものと同じ環境で行われます。

モデルの適用が別のマシン（RapidMiner AI Hubなど）で行われる場合は、同じ名前のPython環境が利用可能か確認してください。利用できない場合は、実行が失敗するか、望ましくない結果になります。

カスタムオペレータの共有と配布

作成したPython LearnerやPython Transformerの動作が十分であれば、次のステップとして、オペレータをプロジェクトに携わる他の人と共有することができます。どちらのオペレータも、パラメータパネルに保存ボタンがあります。

保存をクリックして、プロジェクトやリポジトリの場所を指定すると、 .pyop 記述子のファイルが作成されます。

ユーザーがこの .pyop ファイルをRapidMiner Studioのキャンバスにドラッグすると、コードとパラメータの定義をすべて含むLearnerまたはTransformerが、カスタムオペレータに指定した名前で作成されます。このオペレータは編集できないため、以前書いたコードが意図した通りに実行されることが保証されます（使用するPython環境がRapidMinerプロセスを実行するマシンに存在する場合）。

この共有方法の欠点は、 .pyop 記述子がキャンバスにドラッグされ、新しいオペレータが作成された後に、オペレータを更新することができない点です。これらのオペレータの更新を確実に行う必要がある場合は、カスタムオペレータをエクステンションとして配布する必要があります。そのためには、 .pyop ファイルのあるフォルダを右クリックし、Create Extension…をクリックし、表示されたダイアログに詳細を入力します。また、新しいエクステンションにコンパイルされるカスタムオペレータのリストも表示されます。Create Extensionをクリックします。

エクステンションが作成されると、他のエクステンションと同様に配布することができます。オペレータを更新したいときは、新しいバージョンのエクステンションを作成して、すべてのユーザに再配布します。

注意：作成されたエクステンションはPython Scriptingエクステンションのバージョン9.9以降に依存しているため、各ユーザーもエクステンションをインストールしておく必要があります。