Skip to content

Commit

Permalink
Merge pull request #2048 from recommenders-team/miguel/papermill_readme
Browse files Browse the repository at this point in the history 
Update details of new Recommenders notebook executor
  • Loading branch information
@miguelgfierro
miguelgfierro authored Dec 28, 2023
2 parents 5bf18a0 + 0483268 commit a001787
Show file tree
Hide file tree
Showing 8 changed files with 163 additions and 184 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ This project adheres to [Microsoft's Open Source Code of Conduct](CODE_OF_CONDUC

## Build Status

These tests are the nightly builds, which compute the asynchronous tests. `main` is our principal branch and `staging` is our development branch. We use [pytest](https://docs.pytest.org/) for testing python utilities in [recommenders](recommenders) and [Papermill](https://github.com/nteract/papermill) and [Scrapbook](https://nteract-scrapbook.readthedocs.io/en/latest/) for the [notebooks](examples).
These tests are the nightly builds, which compute the asynchronous tests. `main` is our principal branch and `staging` is our development branch. We use [pytest](https://docs.pytest.org/) for testing python utilities in [recommenders](recommenders) and the Recommenders [notebook executor](recommenders/utils/notebook_utils.py) for the [notebooks](examples).

For more information about the testing pipelines, please see the [test documentation](tests/README.md).

Expand Down
119 changes: 59 additions & 60 deletions examples/01_prepare_data/wikidata_knowledge_graph.ipynb
View file

Large diffs are not rendered by default.

64 changes: 28 additions & 36 deletions examples/02_model_collaborative_filtering/baseline_deep_dive.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 2,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -119,7 +119,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"100%|████████████████████████████████████████████████████████████████████████████| 4.81k/4.81k [00:09<00:00, 495KB/s]\n"
"100%|██████████| 4.81k/4.81k [00:01<00:00, 4.00kKB/s]\n"
]
},
{
Expand Down Expand Up @@ -721,15 +721,14 @@
"outputs": [
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.05500831263949166,
"encoder": "json",
"name": "map",
"version": 1
"name": "map"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "map"
Expand All @@ -739,15 +738,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.2528673962200594,
"encoder": "json",
"name": "ndcg",
"version": 1
"name": "ndcg"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "ndcg"
Expand All @@ -757,15 +755,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.22462845010615715,
"encoder": "json",
"name": "precision",
"version": 1
"name": "precision"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "precision"
Expand All @@ -775,15 +772,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.1117356507425933,
"encoder": "json",
"name": "recall",
"version": 1
"name": "recall"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "recall"
Expand All @@ -793,15 +789,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 1.044885130655045,
"encoder": "json",
"name": "rmse",
"version": 1
"name": "rmse"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "rmse"
Expand All @@ -811,15 +806,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.8369250150730534,
"encoder": "json",
"name": "mae",
"version": 1
"name": "mae"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "mae"
Expand All @@ -829,15 +823,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.1364955485850292,
"encoder": "json",
"name": "exp_var",
"version": 1
"name": "exp_var"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "exp_var"
Expand All @@ -847,15 +840,14 @@
},
{
"data": {
"application/scrapbook.scrap.json+json": {
"application/notebook_utils.json+json": {
"data": 0.13649128638749664,
"encoder": "json",
"name": "rsquared",
"version": 1
"name": "rsquared"
}
},
"metadata": {
"scrapbook": {
"notebook_utils": {
"data": true,
"display": false,
"name": "rsquared"
Expand Down Expand Up @@ -890,9 +882,9 @@
"metadata": {
"celltoolbar": "Tags",
"kernelspec": {
"display_name": "Python (recommenders)",
"display_name": "recommenders",
"language": "python",
"name": "recommenders"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand Down
Loading

0 comments on commit a001787

Please sign in to comment.