この記事は、Numerai Advent Calendar 2021 の2日目の記事です。
numerapiは、Numerai GraphQL APIのPythonクライアントライブラリです。
本記事では、Classic Tounamentに関する機能の早見表を書きました。
現在のnumerapiバージョンはv2.9.4です。
- Method
- メソッド名
- Op (Operation)
- メソッドが実行しているGraphQL APIの操作
-
q(query): データ取得操作 -
m(mutation): データ変更操作 -
-: GraphQLではないので該当なし
-
- メソッドが実行しているGraphQL APIの操作
- Ke (API Key)
-
r(required): APIキー(public_idとsecret_key)が必要
-
- Description
- 機能の概要説明
- Category
- 今回、表を作るにあたり私が作成した大まかな分類です。numerai あるいは numerapiの公式な分類ではありません。
- I roughly make some categories for grouping methods. These are numerai /numerapi unofficial.
| Method | Op | Ke | Description | Category |
|---|---|---|---|---|
| raw_query | q | GraphQL APIを実行。numerapiが未サポートのAPIがあれば、自身でGraphGLを実行可能。 | all | |
| get_leaderboard | q | リーダボード | performance | |
| daily_user_performances | q | モデルの日次パフォーマンス（DEPRECATED） | performance | |
| daily_model_performances | q | モデルの日次パフォーマンス | performance | |
| daily_submissions_performances | q | モデルの日次パフォーマンス（モデル名指定） | performance | |
| round_details | q | ラウンドの全モデルのパフォーマンス（ラウンド指定）。日次ではなく、各ラウンドの最新のみ。 | performance | |
| round_model_performances | q | モデルの全ラウンドのパフォーマンス（ラウンド指定不可） | performance | |
| get_current_round | q | 最新のアクティブなラウンド番号。土曜18:00 UTC（日曜03:00 JST）に更新される。 | round | |
| get_competitions | q | 全ラウンド情報一覧（ラウンド指定不可） | round | |
| check_new_round | q | 新ラウンドの開始確認 | round | |
| list_datasets | q | データセット一覧（ラウンド指定） | dataset | |
| download_dataset | q | データセットをダウンロード（ファイル名指定、ラウンド指定） | dataset | |
| get_dataset_url | q | 旧データセットのURL | dataset | |
| download_current_dataset | - | 最新のアクティブなラウンドの旧データセットをダウンロード | dataset | |
| get_latest_data_url | - | 旧データセットのURL（データタイプ指定） | dataset | |
| download_latest_data | - | 最新のアクティブなラウンドの旧データセットをダウンロード（データタイプ指定） | dataset | |
| set_submission_webhook | m | r | Computeで予測提出する際に使うWebhook | submission |
| upload_predictions | m | r | 予測ファイル提出 | submission |
| get_submission_filenames | q | r | 提出済み予測ファイル一覧（モデルID指定） | submission |
| submission_status | q | r | 旧データ予測提出時のvalidation診断結果（モデルID指定） | submission |
| upload_diagnostics | m | r | 診断対象のvalidation予測ファイル提出 | diagnostics |
| diagnostics | q | r | 診断結果 | diagnostics |
| public_user_profile | q | モデルの公開情報 | account | |
| get_account | q | r | アカウント情報 | account |
| get_models | q | r | アカウントのモデル情報一覧 | account |
| get_account_transactions | q | r | 入出金履歴 (DEPRECATED) | account |
| wallet_transactions | q | r | ウォレットのトランザクション履歴 | account |
| get_user | q | r | アカウント情報 (DEPRECATED) | account |
| stake_set | m | r | ステイクを設定。設定額に合わせてメソッド内部で自動で増減。 | staking |
| stake_get | q | ステイクを取得 | staking | |
| stake_change | m | r | ステイクを変更 | staking |
| stake_drain | m | r | ステイクをゼロにする。メソッド内部ではstake_decreaseで大きい額を指定。 | staking |
| stake_decrease | m | r | ステイクを減らす。メソッド内部ではstake_change。 | staking |
| stake_increase | m | r | ステイクを増やす。メソッド内部ではstake_change。 | staking |