Skip to content

docs: fix spelling and grammar errors in notebook documentation #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Paris778 wants to merge 2 commits into
base: master
Choose a base branch
from
+5,102 −5,142
Open

docs: fix spelling and grammar errors in notebook documentation #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e4c433
docs: fix spelling and grammar errors in notebook documentation
Paris778 Jan 27, 2026
165768e
docs: improve markdown clarity and conciseness across all notebooks
Paris778 Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 52 additions & 52 deletions example_model.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,18 @@
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {
"ExecuteTime": {
"end_time": "2025-12-14T21:09:42.696957Z",
"start_time": "2025-12-14T21:09:42.549138Z"
},
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "Ekw8Z93ljC3v",
"outputId": "bdd16698-2ad0-4423-b090-c5ce55fe3053",
"ExecuteTime": {
"end_time": "2025-12-14T21:09:42.696957Z",
"start_time": "2025-12-14T21:09:42.549138Z"
}
"outputId": "bdd16698-2ad0-4423-b090-c5ce55fe3053"
},
"source": [
"!python --version"
],
"outputs": [
{
"name": "stdout",
Expand All @@ -34,52 +32,79 @@
]
}
],
"execution_count": 1
"source": [
"!python --version"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"ExecuteTime": {
"end_time": "2025-12-14T21:09:44.281889Z",
"start_time": "2025-12-14T21:09:42.698161Z"
},
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "yoy_wT1rhMqF",
"outputId": "e038b50f-1b61-4334-be62-28f4dc40a0a0",
"ExecuteTime": {
"end_time": "2025-12-14T21:09:44.281889Z",
"start_time": "2025-12-14T21:09:42.698161Z"
}
"outputId": "e038b50f-1b61-4334-be62-28f4dc40a0a0"
},
"source": [
"# Install dependencies\n",
"!pip install -q --upgrade numerapi pandas pyarrow matplotlib lightgbm scikit-learn scipy cloudpickle==3.1.1"
],
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\r\n",
"\u001B[1m[\u001B[0m\u001B[34;49mnotice\u001B[0m\u001B[1;39;49m]\u001B[0m\u001B[39;49m A new release of pip is available: \u001B[0m\u001B[31;49m25.2\u001B[0m\u001B[39;49m -> \u001B[0m\u001B[32;49m25.3\u001B[0m\r\n",
"\u001B[1m[\u001B[0m\u001B[34;49mnotice\u001B[0m\u001B[1;39;49m]\u001B[0m\u001B[39;49m To update, run: \u001B[0m\u001B[32;49mpip install --upgrade pip\u001B[0m\r\n"
"\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m25.2\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m25.3\u001b[0m\r\n",
"\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\r\n"
]
}
],
"execution_count": 2
"source": [
"# Install dependencies\n",
"!pip install -q --upgrade numerapi pandas pyarrow matplotlib lightgbm scikit-learn scipy cloudpickle==3.1.1"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"ExecuteTime": {
"end_time": "2025-12-14T21:10:08.471862Z",
"start_time": "2025-12-14T21:09:44.283405Z"
},
"colab": {
"base_uri": "https://localhost:8080/",
"height": 160
},
"id": "13hdRk9ghMqI",
"outputId": "d2274374-fd85-4189-f27b-d9d466cc63ca",
"ExecuteTime": {
"end_time": "2025-12-14T21:10:08.471862Z",
"start_time": "2025-12-14T21:09:44.283405Z"
}
"outputId": "d2274374-fd85-4189-f27b-d9d466cc63ca"
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"2025-12-14 13:09:45,386 INFO numerapi.utils: target file already exists\n",
"2025-12-14 13:09:45,387 INFO numerapi.utils: download complete\n",
"2025-12-14 13:09:46,291 INFO numerapi.utils: target file already exists\n",
"2025-12-14 13:09:46,291 INFO numerapi.utils: download complete\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"[LightGBM] [Info] Auto-choosing row-wise multi-threading, the overhead of testing was 0.001259 seconds.\n",
"You can set `force_row_wise=true` to remove the overhead.\n",
"And if memory is not enough, you can set `force_col_wise=true`.\n",
"[LightGBM] [Info] Total Bins 210\n",
"[LightGBM] [Info] Number of data points in the train set: 688184, number of used features: 42\n",
"[LightGBM] [Info] Start training from score 0.499946\n"
]
}
],
"source": [
"from numerapi import NumerAPI\n",
"import pandas as pd\n",
Expand Down Expand Up @@ -155,32 +180,7 @@
" files.download('example_model.pkl')\n",
"except:\n",
" pass"
],
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"2025-12-14 13:09:45,386 INFO numerapi.utils: target file already exists\n",
"2025-12-14 13:09:45,387 INFO numerapi.utils: download complete\n",
"2025-12-14 13:09:46,291 INFO numerapi.utils: target file already exists\n",
"2025-12-14 13:09:46,291 INFO numerapi.utils: download complete\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"[LightGBM] [Info] Auto-choosing row-wise multi-threading, the overhead of testing was 0.001259 seconds.\n",
"You can set `force_row_wise=true` to remove the overhead.\n",
"And if memory is not enough, you can set `force_col_wise=true`.\n",
"[LightGBM] [Info] Total Bins 210\n",
"[LightGBM] [Info] Number of data points in the train set: 688184, number of used features: 42\n",
"[LightGBM] [Info] Start training from score 0.499946\n"
]
}
],
"execution_count": 3
]
}
],
"metadata": {
Expand Down
Loading