| Title: | Interface to the Numerai Machine Learning Tournament API |
|---|---|
| Description: | Routines to interact with the Numerai Machine Learning Tournament API <https://numer.ai>. The functionality includes the ability to automatically download the current tournament data, submit predictions, and to get information for your user. |
| Authors: | Omni Analytics Group [aut], Eric Hare [cre], Yogesh Bansal [ctb] |
| Maintainer: | Eric Hare <[email protected]> |
| License: | GPL-3 |
| Version: | 3.0.1 |
| Built: | 2025-03-03 03:01:55 UTC |
| Source: | https://github.com/omniacsdao/rnumerai |
Fetch Daily performance of any user
daily_model_performances(username, tournament = 8)daily_model_performances(username, tournament = 8)
username |
User Name |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
list of round model performance entries
## Not run: daily_model_performances(username = "bayo") ## End(Not run)## Not run: daily_model_performances(username = "bayo") ## End(Not run)
Fetch Daily Submission Performance of any user
daily_submission_performances(username, tournament = 8)daily_submission_performances(username, tournament = 8)
username |
User Name |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
list of round model performance entries
## Not run: daily_submission_performances(username = "bayo") ## End(Not run)## Not run: daily_submission_performances(username = "bayo") ## End(Not run)
Fetch results of diagnostics run
diagnostics(model_id, tournament = 8, diagnostics_id)diagnostics(model_id, tournament = 8, diagnostics_id)
model_id |
Target model UUID |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
diagnostics_id |
id returned by "upload_diagnostics" |
Diagnostic results
## Not run: diagnostics(model_id = get_models()[["bayo"]],tournament=8, diagnostics_id = "") ## End(Not run)## Not run: diagnostics(model_id = get_models()[["bayo"]],tournament=8, diagnostics_id = "") ## End(Not run)
Download specified file for the given round.
download_dataset( filename = "v2/numerai_live_data.csv", dest_path = NA, round_num = NA )download_dataset( filename = "v2/numerai_live_data.csv", dest_path = NA, round_num = NA )
filename |
File to be downloaded, defaults to live data |
dest_path |
File path where the file should be stored, Defaults to current directory with filename parameter |
round_num |
Tournament round you are interested in, defaults to the current round. |
list of filenames
## Not run: download_dataset(round_num=328) ## End(Not run)## Not run: download_dataset(round_num=328) ## End(Not run)
Download CSV file with historical targets and ticker universe
download_validation_data(file_path = "signals_historical_targets.csv")download_validation_data(file_path = "signals_historical_targets.csv")
file_path |
CSV file with predictions that will get uploaded |
List of currently accepted tickers
## Not run: download_validation_data(file_path = "signals_historical_targets.csv") ## End(Not run)## Not run: download_validation_data(file_path = "signals_historical_targets.csv") ## End(Not run)
Get all information about your account
get_account()get_account()
User information
## Not run: get_account() ## End(Not run)## Not run: get_account() ## End(Not run)
Gets the Numerai API key
get_api_key()get_api_key()
Your Numerai API key, if set
## Not run: get_api_key() ## End(Not run)## Not run: get_api_key() ## End(Not run)
Retrieves information about all rounds
get_competitions(tournament = 8)get_competitions(tournament = 8)
tournament |
Tournament ID, 8 for Main, 11 for Signal |
Rounds Information
## Not run: get_competitions() ## End(Not run)## Not run: get_competitions() ## End(Not run)
Get number of the current active round.
get_current_round()get_current_round()
Number of the current active round
## Not run: get_current_round() ## End(Not run)## Not run: get_current_round() ## End(Not run)
Get the current leaderboard
get_leaderboard(tournament = 8)get_leaderboard(tournament = 8)
tournament |
Tournament ID, 8 for Main, 11 for Signal |
Leaderboard entries
## Not run: get_leaderboard() ## End(Not run)## Not run: get_leaderboard() ## End(Not run)
Get mapping of account model names to model ids for convenience
get_models(tournament = 8)get_models(tournament = 8)
tournament |
Tournament ID, 8 for Main, 11 for Signal |
modelname -> model_id list
## Not run: get_models() ## End(Not run)## Not run: get_models() ## End(Not run)
Gets the Numerai Public ID
get_public_id()get_public_id()
Your Numerai Public ID, if set
## Not run: get_public_id() ## End(Not run)## Not run: get_public_id() ## End(Not run)
List of available data files
list_datasets(round_num = NA)list_datasets(round_num = NA)
round_num |
Tournament round you are interested in, defaults to the current round. |
list of filenames
## Not run: list_datasets(round_num=328) ## End(Not run)## Not run: list_datasets(round_num=328) ## End(Not run)
Fetch round model performance of any user
round_model_performances(username, tournament = 8)round_model_performances(username, tournament = 8)
username |
User Name |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
list of round model performance entries
## Not run: round_model_performances(username = "bayo") ## End(Not run)## Not run: round_model_performances(username = "bayo") ## End(Not run)
Run a custom query
run_query(query, auth = TRUE)run_query(query, auth = TRUE)
query |
Query to pass as a string |
auth |
Whether the query need authorisation to run |
Parsed result from custom query
## Not run: run_query(query = 'query{account{username }}', auth=TRUE) ## End(Not run)## Not run: run_query(query = 'query{account{username }}', auth=TRUE) ## End(Not run)
Sets the Numerai API key
set_api_key(key)set_api_key(key)
key |
The Numerai API key |
A boolean TRUE if the key was successfully set
## Not run: set_api_key("abcdefghijklmnop") ## End(Not run)## Not run: set_api_key("abcdefghijklmnop") ## End(Not run)
Set bio field for a model id
set_bio(model_id, bio)set_bio(model_id, bio)
model_id |
Target model UUID |
bio |
Bio to change |
If the bio was changed successfully
## Not run: set_bio(model_id = get_models()[["bayo"]], bio = "This Model Rocks") ## End(Not run)## Not run: set_bio(model_id = get_models()[["bayo"]], bio = "This Model Rocks") ## End(Not run)
Set link field for a model id
set_link(model_id, link, link_text)set_link(model_id, link, link_text)
model_id |
Target model UUID |
link |
URL |
link_text |
URL Text |
If the link was changed successfully
## Not run: set_link(model_id = get_models()[["bayo"]], link = "https://www.google.com",link_text = "Google") ## End(Not run)## Not run: set_link(model_id = get_models()[["bayo"]], link = "https://www.google.com",link_text = "Google") ## End(Not run)
Sets the Numerai Public ID
set_public_id(id)set_public_id(id)
id |
The Numerai Public ID |
A boolean TRUE if the ID was successfully set
## Not run: set_public_id("abcdefghijklmnop") ## End(Not run)## Not run: set_public_id("abcdefghijklmnop") ## End(Not run)
Change stake type by model
set_stake_type( model_id, corr_multiplier = 0, tc_multiplier = 0, take_profit = FALSE, tournament = 8 )set_stake_type( model_id, corr_multiplier = 0, tc_multiplier = 0, take_profit = FALSE, tournament = 8 )
model_id |
Target model UUID |
corr_multiplier |
Multiplier of correlation for returns (Integer) |
tc_multiplier |
Multiplier of TC for returns (Numeric) |
take_profit |
TRUE/FALSE Determines whether payouts are returned to user wallet or automatically staked to next round. |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
Confirmation that payout selection has been updated
## Not run: set_stake_type(model_id = get_models()[["bayo"]],corr_multiplier=1,tc_multiplier=3,tournament=8) ## End(Not run)## Not run: set_stake_type(model_id = get_models()[["bayo"]],corr_multiplier=1,tc_multiplier=3,tournament=8) ## End(Not run)
Set a model's submission webhook used in Numerai Compute
set_submission_webhook(model_id, webhook)set_submission_webhook(model_id, webhook)
model_id |
Target model UUID |
webhook |
The compute webhook to trigger this model |
Confirmation that your webhook has been set
## Not run: set_submission_webhook(model_id = get_models()[["bayo"]], webhook = "..") ## End(Not run)## Not run: set_submission_webhook(model_id = get_models()[["bayo"]], webhook = "..") ## End(Not run)
Change stake by 'value' NMR
stake_change(nmr, action = "decrease", model_id, tournament = 8)stake_change(nmr, action = "decrease", model_id, tournament = 8)
nmr |
amount of NMR you want to increase/decrease |
action |
'increase' or 'decrease' |
model_id |
Target model UUID |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
Stake change information
## Not run: stake_change(nmr=10,action="decrease",model_id = get_models()[["bayo"]],tournament=8) ## End(Not run)## Not run: stake_change(nmr=10,action="decrease",model_id = get_models()[["bayo"]],tournament=8) ## End(Not run)
Submission status of the last submission associated with the account
submission_status(model_id, tournament = 8)submission_status(model_id, tournament = 8)
model_id |
Target model UUID |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
Submission status and stats
## Not run: model_id = get_models()[["bayo"]] submission_status(model_id = model_id,tournament=8) ## End(Not run)## Not run: model_id = get_models()[["bayo"]] submission_status(model_id = model_id,tournament=8) ## End(Not run)
Fetch universe of accepted tickers
ticker_universe()ticker_universe()
List of currently accepted tickers
## Not run: ticker_universe() ## End(Not run)## Not run: ticker_universe() ## End(Not run)
Upload predictions to diagnostics from file.
upload_diagnostics(file_path = NA, model_id, df = NA, tournament = 8)upload_diagnostics(file_path = NA, model_id, df = NA, tournament = 8)
file_path |
CSV file with predictions that will get uploaded |
model_id |
Target model UUID (required for accounts with multiple models) |
df |
DataFrame to upload, if given both df and file_path, df will be uploaded. |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
diagnostics_id
## Not run: upload_diagnostics(file_path = "prediction.csv",model_id = get_models()[["bayo"]]) ## End(Not run)## Not run: upload_diagnostics(file_path = "prediction.csv",model_id = get_models()[["bayo"]]) ## End(Not run)
Upload predictions from file.
upload_predictions(file_path = NA, model_id, df = NA, tournament = 8)upload_predictions(file_path = NA, model_id, df = NA, tournament = 8)
file_path |
CSV file with predictions that will get uploaded |
model_id |
Target model UUID (required for accounts with multiple models) |
df |
DataFrame to upload, if given both df and file_path, df will be uploaded. |
tournament |
Tournament ID, 8 for Main, 11 for Signal |
submission_id
## Not run: upload_predictions(file_path = "prediction.csv",model_id = get_models()[["bayo"]]) ## End(Not run)## Not run: upload_predictions(file_path = "prediction.csv",model_id = get_models()[["bayo"]]) ## End(Not run)
Get all transactions in your wallet.
wallet_transactions()wallet_transactions()
Wallet Txs Data Frame
## Not run: wallet_transactions() ## End(Not run)## Not run: wallet_transactions() ## End(Not run)