Skip to content

Commit

Permalink
docs and nb edits
Browse files Browse the repository at this point in the history
  • Loading branch information
@rbyh
rbyh committed Feb 8, 2025
1 parent 0d1c621 commit 6e0d318
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 67 deletions.
120 changes: 75 additions & 45 deletions docs/notebooks/image_scenario_example.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@
"text/plain": [
"{'description': 'File: parrot_logo.png',\n",
" 'object_type': 'scenario',\n",
" 'url': 'https://www.expectedparrot.com/content/dc2e3ede-54bb-4470-a51e-927d45d91293',\n",
" 'uuid': 'dc2e3ede-54bb-4470-a51e-927d45d91293',\n",
" 'version': '0.1.42.dev1',\n",
" 'url': 'https://www.expectedparrot.com/content/c08e9ec6-cb24-49fc-bb88-dc77e3edde14',\n",
" 'uuid': 'c08e9ec6-cb24-49fc-bb88-dc77e3edde14',\n",
" 'version': '0.1.43.dev1',\n",
" 'visibility': 'unlisted'}"
]
},
Expand Down Expand Up @@ -264,24 +264,24 @@
"text/html": [
"\n",
" <!-- #region Remove Inference Info -->\n",
" <div id=\"logger-d6aa826b-f01e-434f-9a9f-e448a9f911e5\" class=\"job-logger\">\n",
" <div id=\"logger-9e1a36a2-e025-498c-8cdc-c78966c81e8a\" class=\"job-logger\">\n",
" <div class=\"job-logger-header\">\n",
" <span>\n",
" <span id=\"arrow-d6aa826b-f01e-434f-9a9f-e448a9f911e5\">▼</span> \n",
" Job Status (2025-01-23 09:18:31)\n",
" <span id=\"arrow-9e1a36a2-e025-498c-8cdc-c78966c81e8a\">▼</span> \n",
" Job Status (2025-02-07 19:25:34)\n",
" </span>\n",
" </div>\n",
" <div id=\"content-d6aa826b-f01e-434f-9a9f-e448a9f911e5\" style=\"display: block;\">\n",
" <div id=\"content-9e1a36a2-e025-498c-8cdc-c78966c81e8a\" style=\"display: block;\">\n",
" <table class=\"job-logger-table\">\n",
" \n",
" <tr>\n",
" <td class=\"job-logger-cell job-logger-label\">Job UUID</td>\n",
" <td class=\"job-logger-cell job-logger-value\">0fd3ad6e-b01a-449d-ac7c-f90c557cecd3</td>\n",
" <td class=\"job-logger-cell job-logger-value\">c2d11906-e903-43b5-ac18-c4a990955481</td>\n",
" </tr>\n",
" \n",
" <tr>\n",
" <td class=\"job-logger-cell job-logger-label\">Progress Bar URL</td>\n",
" <td class=\"job-logger-cell job-logger-value\"><a href=\"https://www.expectedparrot.com/home/remote-job-progress/0fd3ad6e-b01a-449d-ac7c-f90c557cecd3\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/home/remote-job-progress/0fd3ad6e-b01a-449d-ac7c-f90c557cecd3</a></td>\n",
" <td class=\"job-logger-cell job-logger-value\"><a href=\"https://www.expectedparrot.com/home/remote-job-progress/c2d11906-e903-43b5-ac18-c4a990955481\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/home/remote-job-progress/c2d11906-e903-43b5-ac18-c4a990955481</a></td>\n",
" </tr>\n",
" \n",
" <tr>\n",
Expand All @@ -291,18 +291,18 @@
" \n",
" <tr>\n",
" <td class=\"job-logger-cell job-logger-label\">Results UUID</td>\n",
" <td class=\"job-logger-cell job-logger-value\">e1a2d0c9-1aff-47f7-be63-5d0cfd47b633</td>\n",
" <td class=\"job-logger-cell job-logger-value\">e714554d-d9f9-48ca-8e24-efc4b7dbe5cd</td>\n",
" </tr>\n",
" \n",
" <tr>\n",
" <td class=\"job-logger-cell job-logger-label\">Results URL</td>\n",
" <td class=\"job-logger-cell job-logger-value\"><a href=\"https://www.expectedparrot.com/content/e1a2d0c9-1aff-47f7-be63-5d0cfd47b633\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/content/e1a2d0c9-1aff-47f7-be63-5d0cfd47b633</a></td>\n",
" <td class=\"job-logger-cell job-logger-value\"><a href=\"https://www.expectedparrot.com/content/e714554d-d9f9-48ca-8e24-efc4b7dbe5cd\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/content/e714554d-d9f9-48ca-8e24-efc4b7dbe5cd</a></td>\n",
" </tr>\n",
" \n",
" </table>\n",
" \n",
" <div class=\"job-logger-status\">\n",
" <span style=\"margin-right: 8px;\" class=\"job-logger-success\">✓</span><strong>Current Status:</strong> Job completed and Results stored on Coop: <a href=\"https://www.expectedparrot.com/content/e1a2d0c9-1aff-47f7-be63-5d0cfd47b633\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/content/e1a2d0c9-1aff-47f7-be63-5d0cfd47b633</a>\n",
" <span style=\"margin-right: 8px;\" class=\"job-logger-success\">✓</span><strong>Current Status:</strong> Job completed and Results stored on Coop: <a href=\"https://www.expectedparrot.com/content/e714554d-d9f9-48ca-8e24-efc4b7dbe5cd\" target=\"_blank\" class=\"job-logger-link\">https://www.expectedparrot.com/content/e714554d-d9f9-48ca-8e24-efc4b7dbe5cd</a>\n",
" </div>\n",
" \n",
" </div>\n",
Expand Down Expand Up @@ -509,7 +509,7 @@
" \n",
" <script>\n",
" document.addEventListener('DOMContentLoaded', () => {\n",
" window.initThemeManager('d6aa826b-f01e-434f-9a9f-e448a9f911e5', 'auto');\n",
" window.initThemeManager('9e1a36a2-e025-498c-8cdc-c78966c81e8a', 'auto');\n",
" });\n",
" </script>\n",
" "
Expand All @@ -536,7 +536,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": 14,
"id": "acdf9eb5-ebf2-4ea1-991a-8bd69230ea0f",
"metadata": {},
"outputs": [
Expand All @@ -546,31 +546,31 @@
"\n",
" <div style=\"max-height: 500px; overflow-y: auto;\">\n",
" <style type=\"text/css\">\n",
"#T_5f3ed_row0_col0, #T_5f3ed_row0_col1, #T_5f3ed_row0_col2, #T_5f3ed_row0_col3, #T_5f3ed_row0_col4, #T_5f3ed_row0_col5 {\n",
"#T_4344d_row0_col0, #T_4344d_row0_col1, #T_4344d_row0_col2, #T_4344d_row0_col3, #T_4344d_row0_col4, #T_4344d_row0_col5 {\n",
" text-align: left;\n",
"}\n",
"</style>\n",
"<table id=\"T_5f3ed\">\n",
"<table id=\"T_4344d\">\n",
" <thead>\n",
" <tr>\n",
" <th class=\"blank level0\" >&nbsp;</th>\n",
" <th id=\"T_5f3ed_level0_col0\" class=\"col_heading level0 col0\" >model.model</th>\n",
" <th id=\"T_5f3ed_level0_col1\" class=\"col_heading level0 col1\" >scenario.filename</th>\n",
" <th id=\"T_5f3ed_level0_col2\" class=\"col_heading level0 col2\" >answer.animal</th>\n",
" <th id=\"T_5f3ed_level0_col3\" class=\"col_heading level0 col3\" >answer.identify</th>\n",
" <th id=\"T_5f3ed_level0_col4\" class=\"col_heading level0 col4\" >answer.colors</th>\n",
" <th id=\"T_5f3ed_level0_col5\" class=\"col_heading level0 col5\" >comment.colors_comment</th>\n",
" <th id=\"T_4344d_level0_col0\" class=\"col_heading level0 col0\" >model.model</th>\n",
" <th id=\"T_4344d_level0_col1\" class=\"col_heading level0 col1\" >scenario.filename</th>\n",
" <th id=\"T_4344d_level0_col2\" class=\"col_heading level0 col2\" >answer.animal</th>\n",
" <th id=\"T_4344d_level0_col3\" class=\"col_heading level0 col3\" >answer.identify</th>\n",
" <th id=\"T_4344d_level0_col4\" class=\"col_heading level0 col4\" >answer.colors</th>\n",
" <th id=\"T_4344d_level0_col5\" class=\"col_heading level0 col5\" >comment.colors_comment</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <th id=\"T_5f3ed_level0_row0\" class=\"row_heading level0 row0\" >0</th>\n",
" <td id=\"T_5f3ed_row0_col0\" class=\"data row0 col0\" >gemini-1.5-flash</td>\n",
" <td id=\"T_5f3ed_row0_col1\" class=\"data row0 col1\" >parrot_logo.png</td>\n",
" <td id=\"T_5f3ed_row0_col2\" class=\"data row0 col2\" >Yes</td>\n",
" <td id=\"T_5f3ed_row0_col3\" class=\"data row0 col3\" >bird</td>\n",
" <td id=\"T_5f3ed_row0_col4\" class=\"data row0 col4\" >['green', 'orange', 'red', 'blue']</td>\n",
" <td id=\"T_5f3ed_row0_col5\" class=\"data row0 col5\" >The parrot is primarily green, with orange on its beak, red and blue on its underside.</td>\n",
" <th id=\"T_4344d_level0_row0\" class=\"row_heading level0 row0\" >0</th>\n",
" <td id=\"T_4344d_row0_col0\" class=\"data row0 col0\" >gemini-1.5-flash</td>\n",
" <td id=\"T_4344d_row0_col1\" class=\"data row0 col1\" >parrot_logo.png</td>\n",
" <td id=\"T_4344d_row0_col2\" class=\"data row0 col2\" >Yes</td>\n",
" <td id=\"T_4344d_row0_col3\" class=\"data row0 col3\" >bird</td>\n",
" <td id=\"T_4344d_row0_col4\" class=\"data row0 col4\" >['green', 'orange', 'red', 'blue']</td>\n",
" <td id=\"T_4344d_row0_col5\" class=\"data row0 col5\" >The parrot is primarily green, with orange on its beak, red and blue on its lower body.</td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n",
Expand All @@ -579,10 +579,10 @@
" "
],
"text/plain": [
"Dataset([{'model.model': ['gemini-1.5-flash']}, {'scenario.filename': ['parrot_logo.png']}, {'answer.animal': ['Yes']}, {'answer.identify': ['bird']}, {'answer.colors': [['green', 'orange', 'red', 'blue']]}, {'comment.colors_comment': ['The parrot is primarily green, with orange on its beak, red and blue on its underside.']}])"
"Dataset([{'model.model': ['gemini-1.5-flash']}, {'scenario.filename': ['parrot_logo.png']}, {'answer.animal': ['Yes']}, {'answer.identify': ['bird']}, {'answer.colors': [['green', 'orange', 'red', 'blue']]}, {'comment.colors_comment': ['The parrot is primarily green, with orange on its beak, red and blue on its lower body.']}])"
]
},
"execution_count": 13,
"execution_count": 14,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -603,7 +603,7 @@
},
{
"cell_type": "code",
"execution_count": 14,
"execution_count": 15,
"id": "de22063a-6430-4142-bf89-88221ed9bef6",
"metadata": {
"editable": true,
Expand Down Expand Up @@ -634,25 +634,43 @@
"skip-execution"
]
},
"outputs": [],
"source": [
"info = n.push(description = \"Using an image scenario\", visibility = \"public\")"
]
},
{
"cell_type": "code",
"execution_count": 17,
"id": "d64f12e5-0272-4c20-9917-da9106f96a61",
"metadata": {
"editable": true,
"slideshow": {
"slide_type": ""
},
"tags": [
"skip-execution"
]
},
"outputs": [
{
"data": {
"text/plain": [
"{'description': 'Using an image scenario',\n",
" 'object_type': 'notebook',\n",
" 'url': 'https://www.expectedparrot.com/content/e82e61b1-8563-42d3-af3a-e3eae2b27804',\n",
" 'uuid': 'e82e61b1-8563-42d3-af3a-e3eae2b27804',\n",
" 'version': '0.1.39.dev2',\n",
" 'url': 'https://www.expectedparrot.com/content/14167a50-ff40-446c-a879-ceb1c70e7aa1',\n",
" 'uuid': '14167a50-ff40-446c-a879-ceb1c70e7aa1',\n",
" 'version': '0.1.43.dev1',\n",
" 'visibility': 'public'}"
]
},
"execution_count": 16,
"execution_count": 17,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"n.push(description = \"Using an image scenario\", visibility = \"public\")"
"info"
]
},
{
Expand All @@ -670,17 +688,29 @@
]
},
{
"cell_type": "markdown",
"id": "571bf6d8-d12d-428a-8b94-edac4780555a",
"metadata": {},
"cell_type": "code",
"execution_count": 18,
"id": "dac344e6-8727-404b-90f7-42afb91d5a04",
"metadata": {
"editable": true,
"slideshow": {
"slide_type": ""
},
"tags": [
"skip-execution"
]
},
"outputs": [],
"source": [
"To update an object at Coop:"
"from edsl import Notebook\n",
"\n",
"n = Notebook(path = \"image_scenario_example.ipynb\")"
]
},
{
"cell_type": "code",
"execution_count": 15,
"id": "4a96a877-64e7-4e0b-965c-b5eafd10cb68",
"execution_count": 19,
"id": "6db6b02e-7fa3-4573-b79b-db387075e936",
"metadata": {
"editable": true,
"slideshow": {
Expand All @@ -697,13 +727,13 @@
"{'status': 'success'}"
]
},
"execution_count": 15,
"execution_count": 19,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"n.patch(uuid = \"b72f3990-0630-4aa7-99c8-2230d51376d1\", value = n)"
"n.patch(uuid = info[\"uuid\"], value = n)"
]
}
],
Expand Down
44 changes: 22 additions & 22 deletions docs/scenarios.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -386,21 +386,21 @@ This will return:
- color
- shape
* - apple
-
-
-
* -
- nan
- nan
- nan
* - nan
- water
-
-
* -
-
- nan
- nan
* - nan
- nan
- nan
- red
-
* -
-
-
- circle
* - nan
- nan
- circle
- nan


We can create a cross product of `ScenarioList` objects (combine the scenarios in each list with each other):
Expand All @@ -427,21 +427,21 @@ This will return:
- color
- shape
* - apple
-
- nan
- nan
- red
-
* - apple
-
-
- nan
- circle
* -
- red
- nan
* - nan
- water
-
* -
-
- nan
- red
* - nan
- water
- circle
- nan


Creating scenarios from a dataset
Expand Down

0 comments on commit 6e0d318

Please sign in to comment.