{ "cells": [ { "cell_type": "markdown", "id": "affecting-robertson", "metadata": {}, "source": [ "# Python Client Example\n", "\n", "Initialize our Compute Studio API client with the Tax-Brain webapp. Before doing this, make sure to set up your [authentication credentials](https://docs.compute.studio/api/auth.html).\n", "\n", "You can learn more about the specific methods used in this notebook in the [Python API documentation](/api/python-api/).\n", "\n", "Save your token at `~/.cs_api_token` OR pass it directly to the C/S client:\n", "\n", "```python\n", "cs = cs_kit.ComputeStudio(\"hdoupe\", \"Matchups\", api_token=\"your token\")\n", "```\n" ] }, { "cell_type": "code", "execution_count": 1, "id": "aggressive-institution", "metadata": {}, "outputs": [], "source": [ "import cs_kit\n", "matchups = cs_kit.ComputeStudio(\"hdoupe\", \"Matchups\")" ] }, { "cell_type": "markdown", "id": "korean-insert", "metadata": {}, "source": [ "Checkout the inputs documentation for Matchups using the `inputs` method:" ] }, { "cell_type": "code", "execution_count": 2, "id": "corrected-mechanism", "metadata": {}, "outputs": [ { "data": { "text/plain": [ "{'model_parameters': {'matchup': {'schema': {'labels': {'use_full_sample': {'number_dims': 0,\n", " 'validators': {'choice': {'choices': [True, False]}},\n", " 'type': 'bool'}},\n", " 'additional_members': {'section_1': {'number_dims': 0, 'type': 'str'},\n", " 'section_2': {'number_dims': 0, 'type': 'str'}},\n", " 'operators': {'array_first': False,\n", " 'label_to_extend': None,\n", " 'uses_extend_func': False}},\n", " 'start_date': {'title': 'Start Date',\n", " 'description': 'Date to start pulling statcast information',\n", " 'notes': 'If using the 2020 dataset, only use dates in 2020.',\n", " 'type': 'date',\n", " 'number_dims': 0,\n", " 'value': [{'use_full_sample': True, 'value': '2009-01-01'}],\n", " 'validators': {'date_range': {'max': 'end_date', 'min': '2009-01-01'}},\n", " 'section_1': 'Date',\n", " 'section_2': ''},\n", " 'end_date': {'title': 'End Date',\n", " 'description': 'Date to quit pulling statcast information',\n", " 'notes': 'If using the 2020 dataset, only use dates in 2020.',\n", " 'type': 'date',\n", " 'number_dims': 0,\n", " 'value': [{'use_full_sample': True, 'value': '2020-11-10'}],\n", " 'validators': {'date_range': {'max': '2020-11-10', 'min': '2009-01-01'}},\n", " 'section_1': 'Date',\n", " 'section_2': ''},\n", " 'pitcher': {'title': 'Pitcher Name',\n", " 'description': 'Name of pitcher to pull data on',\n", " 'notes': 'Make sure the name of the pitcher is correct. A good place to reference this is baseball-reference.com',\n", " 'type': 'str',\n", " 'number_dims': 0,\n", " 'value': [{'use_full_sample': True, 'value': 'Max Scherzer'}],\n", " 'validators': {},\n", " 'section_1': 'Parameters',\n", " 'section_2': 'Pitcher'},\n", " 'batter': {'title': 'Batter Name',\n", " 'description': 'Name of batter for pitching matchup analysis',\n", " 'notes': 'Make sure the name of the batter is correct. A good place to reference this is baseball-reference.com',\n", " 'type': 'str',\n", " 'number_dims': 1,\n", " 'value': [{'use_full_sample': True, 'value': ['Freddie Freeman']}],\n", " 'validators': {},\n", " 'section_1': 'Parameters',\n", " 'section_2': 'Batter'}}},\n", " 'meta_parameters': {'schema': {'labels': {},\n", " 'additional_members': {},\n", " 'operators': {'uses_extend_func': False,\n", " 'array_first': True,\n", " 'label_to_extend': None}},\n", " 'use_full_sample': {'title': 'Use Full Data',\n", " 'description': 'Flag that determines whether Matchups uses the 10 year data set or the 2020 data set.',\n", " 'type': 'bool',\n", " 'number_dims': 0,\n", " 'value': [{'value': True}],\n", " 'validators': {'choice': {'choices': [True, False]}}}}}" ] }, "execution_count": 2, "metadata": {}, "output_type": "execute_result" } ], "source": [ "inputs = matchups.inputs()\n", "inputs" ] }, { "cell_type": "markdown", "id": "leading-allen", "metadata": {}, "source": [ "Create a new \"simulation\" to look at what pitches Walker Buehler, a pitcher for the Los Angeles Dodgers, threw to Freddie Freeman and Ronald Acuna, my favorite players on the Atlanta Braves, in the 2020 NLCS." ] }, { "cell_type": "code", "execution_count": 3, "id": "personal-vacuum", "metadata": {}, "outputs": [ { "data": { "text/plain": [ "{'api_url': '/hdoupe/Matchups/api/v1/94/',\n", " 'authors': ['hdoupe'],\n", " 'creation_date': '2021-02-08T15:01:37.569658Z',\n", " 'eta': 24.951767,\n", " 'exp_comp_datetime': '2021-02-08T15:02:02.569658Z',\n", " 'gui_url': '/hdoupe/Matchups/94/',\n", " 'is_public': True,\n", " 'model_pk': 94,\n", " 'model_version': None,\n", " 'notify_on_completion': False,\n", " 'original_eta': 25.0,\n", " 'outputs': None,\n", " 'owner': 'hdoupe',\n", " 'outputs_version': None,\n", " 'project': {'app_location': None,\n", " 'title': 'Matchups',\n", " 'oneliner': 'Analyze pitcher-batter matchups over the last 10 years',\n", " 'description': \"[Matchups](https://github.com/hdoupe/Matchups) provides pitch data on pitcher and batter matchups.. Select a date range using the format YYYY-MM-DD. Keep in mind that Matchups only provides data on matchups going back to 2008. Two datasets are offered to run this model: one that only has the most recent season, 2018, and one that contains data on every single pitch going back to 2008. Next, select your favorite pitcher and some batters who he's faced in the past. Click submit to start analyzing the selected matchups!\",\n", " 'repo_url': 'https://github.com/hdoupe/Matchups',\n", " 'repo_tag': 'master',\n", " 'latest_tag': 'f0af41930298fa9950cef51b736b704b40bd31e8',\n", " 'exp_task_time': 25,\n", " 'server_cost': 0.06116,\n", " 'cpu': '2.0',\n", " 'memory': '6.0',\n", " 'listed': True,\n", " 'owner': 'hdoupe',\n", " 'cluster_type': 'single-core',\n", " 'sim_count': 94,\n", " 'status': 'running',\n", " 'user_count': 11,\n", " 'callable_name': None,\n", " 'tech': 'python-paramtools',\n", " 'is_public': True,\n", " 'has_write_access': True},\n", " 'readme': None,\n", " 'run_time': 0,\n", " 'status': 'PENDING',\n", " 'title': 'Untitled Simulation',\n", " 'traceback': None,\n", " 'parent_sims': [],\n", " 'role': 'admin',\n", " 'pending_permissions': [],\n", " 'access': [{'is_owner': True, 'role': 'admin', 'username': 'hdoupe'}]}" ] }, "execution_count": 3, "metadata": {}, "output_type": "execute_result" } ], "source": [ "response = matchups.create(\n", " adjustment={\n", " \"matchup\": {\n", " \"pitcher\": [{\"value\": \"Walker Buehler\"}],\n", " \"batter\": [{\"value\": [\"Freddie Freeman\", \"Ronald Acuna\"]}],\n", " \"start_date\": [{\"value\": \"2020-10-12\"}],\n", " \"end_date\": [{\"value\": \"2020-10-18\"}]\n", " }\n", " }\n", ")\n", "response" ] }, { "cell_type": "markdown", "id": "olympic-stamp", "metadata": {}, "source": [ "The new simulation is now available at the following URL:" ] }, { "cell_type": "code", "execution_count": 4, "id": "seeing-carbon", "metadata": {}, "outputs": [ { "data": { "text/plain": [ "'https://compute.studio/hdoupe/Matchups/94/'" ] }, "execution_count": 4, "metadata": {}, "output_type": "execute_result" } ], "source": [ "f\"https://compute.studio{response['gui_url']}\"" ] }, { "cell_type": "markdown", "id": "rubber-welcome", "metadata": {}, "source": [ "Use the API to update the simulation title and get a notification once the simulation is complete:" ] }, { "cell_type": "code", "execution_count": 5, "id": "existing-special", "metadata": {}, "outputs": [ { "data": { "text/plain": [ "{'api_url': '/hdoupe/Matchups/api/v1/94/',\n", " 'authors': ['hdoupe'],\n", " 'creation_date': '2021-02-08T15:01:37.569658Z',\n", " 'gui_url': '/hdoupe/Matchups/94/',\n", " 'is_public': True,\n", " 'model_pk': 94,\n", " 'model_version': None,\n", " 'notify_on_completion': True,\n", " 'owner': 'hdoupe',\n", " 'project': 'hdoupe/Matchups',\n", " 'readme': None,\n", " 'status': 'PENDING',\n", " 'title': 'Walker Beuhler vs My Favorite Braves Players in 2020 NLCS',\n", " 'role': 'admin'}" ] }, "execution_count": 5, "metadata": {}, "output_type": "execute_result" } ], "source": [ "matchups.update(\n", " model_pk=response[\"model_pk\"],\n", " title=\"Walker Beuhler vs My Favorite Braves Players in 2020 NLCS\",\n", " notify_on_completion=True,\n", " is_public=True,\n", ")" ] }, { "cell_type": "markdown", "id": "moral-attack", "metadata": {}, "source": [ "Download the results as a pandas dataframe and analyze them locally:" ] }, { "cell_type": "code", "execution_count": 6, "id": "touched-seventh", "metadata": {}, "outputs": [ { "data": { "text/html": [ "
\n", "\n", "\n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", "
Unnamed: 0release_speedlaunch_speedwoba_valueballsstrikesouts_when_upat_bat_numberplate_xplate_z
count22.00000022.000005.0000006.00000022.00000022.00000022.00000022.00000022.00000022.000000
mean4134.95454593.9500094.7400000.6000000.7727270.9545451.04545516.8181820.2745452.088636
std1735.7332884.8113718.3494690.7924650.9223070.7854190.21320112.6740691.0608031.349029
min2191.00000082.1000063.5000000.0000000.0000000.0000001.0000002.000000-2.500000-1.330000
25%2275.00000091.7750096.8000000.0000000.0000000.0000001.0000002.000000-0.1875001.622500
50%5595.50000095.8000099.1000000.3500000.5000001.0000001.00000021.0000000.3400002.025000
75%5665.75000097.30000102.7000000.8500001.0000001.7500001.00000023.0000000.7275002.655000
max5754.00000099.00000111.6000002.0000003.0000002.0000002.00000041.0000002.1000005.880000
\n", "
" ], "text/plain": [ " Unnamed: 0 release_speed launch_speed woba_value balls \\\n", "count 22.000000 22.00000 5.000000 6.000000 22.000000 \n", "mean 4134.954545 93.95000 94.740000 0.600000 0.772727 \n", "std 1735.733288 4.81137 18.349469 0.792465 0.922307 \n", "min 2191.000000 82.10000 63.500000 0.000000 0.000000 \n", "25% 2275.000000 91.77500 96.800000 0.000000 0.000000 \n", "50% 5595.500000 95.80000 99.100000 0.350000 0.500000 \n", "75% 5665.750000 97.30000 102.700000 0.850000 1.000000 \n", "max 5754.000000 99.00000 111.600000 2.000000 3.000000 \n", "\n", " strikes outs_when_up at_bat_number plate_x plate_z \n", "count 22.000000 22.000000 22.000000 22.000000 22.000000 \n", "mean 0.954545 1.045455 16.818182 0.274545 2.088636 \n", "std 0.785419 0.213201 12.674069 1.060803 1.349029 \n", "min 0.000000 1.000000 2.000000 -2.500000 -1.330000 \n", "25% 0.000000 1.000000 2.000000 -0.187500 1.622500 \n", "50% 1.000000 1.000000 21.000000 0.340000 2.025000 \n", "75% 1.750000 1.000000 23.000000 0.727500 2.655000 \n", "max 2.000000 2.000000 41.000000 2.100000 5.880000 " ] }, "execution_count": 6, "metadata": {}, "output_type": "execute_result" } ], "source": [ "results = matchups.results(response[\"model_pk\"], timeout=60)\n", "results[\"Walker Buehler v. Freddie Freeman\"].describe()" ] }, { "cell_type": "code", "execution_count": 7, "id": "reduced-darwin", "metadata": {}, "outputs": [ { "data": { "text/html": [ "
\n", "\n", "\n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", " \n", "
Unnamed: 0release_speedlaunch_speedwoba_valueballsstrikesouts_when_upat_bat_numberplate_xplate_z
count19.00000019.0000005.0000006.019.00000019.00000019.00000019.00000019.00000019.000000
mean4396.21052693.40526390.6600000.00.5789470.9473680.10526324.1578950.0178952.390526
std1676.3660624.8156547.9600880.00.8377080.8481150.31530212.7290710.7127530.896763
min2192.00000080.90000080.1000000.00.0000000.0000000.0000001.000000-0.7100000.960000
25%2295.50000089.05000086.9000000.00.0000000.0000000.00000020.000000-0.4950001.800000
50%5599.00000095.70000089.9000000.00.0000001.0000000.00000022.000000-0.3700002.340000
75%5668.50000096.45000095.6000000.01.0000002.0000000.00000035.0000000.4700002.665000
max5755.00000098.000000100.8000000.03.0000002.0000001.00000040.0000001.4600005.020000
\n", "
" ], "text/plain": [ " Unnamed: 0 release_speed launch_speed woba_value balls \\\n", "count 19.000000 19.000000 5.000000 6.0 19.000000 \n", "mean 4396.210526 93.405263 90.660000 0.0 0.578947 \n", "std 1676.366062 4.815654 7.960088 0.0 0.837708 \n", "min 2192.000000 80.900000 80.100000 0.0 0.000000 \n", "25% 2295.500000 89.050000 86.900000 0.0 0.000000 \n", "50% 5599.000000 95.700000 89.900000 0.0 0.000000 \n", "75% 5668.500000 96.450000 95.600000 0.0 1.000000 \n", "max 5755.000000 98.000000 100.800000 0.0 3.000000 \n", "\n", " strikes outs_when_up at_bat_number plate_x plate_z \n", "count 19.000000 19.000000 19.000000 19.000000 19.000000 \n", "mean 0.947368 0.105263 24.157895 0.017895 2.390526 \n", "std 0.848115 0.315302 12.729071 0.712753 0.896763 \n", "min 0.000000 0.000000 1.000000 -0.710000 0.960000 \n", "25% 0.000000 0.000000 20.000000 -0.495000 1.800000 \n", "50% 1.000000 0.000000 22.000000 -0.370000 2.340000 \n", "75% 2.000000 0.000000 35.000000 0.470000 2.665000 \n", "max 2.000000 1.000000 40.000000 1.460000 5.020000 " ] }, "execution_count": 7, "metadata": {}, "output_type": "execute_result" } ], "source": [ "results[\"Walker Buehler v. Ronald Acuna\"].describe()" ] }, { "cell_type": "markdown", "id": "uniform-request", "metadata": {}, "source": [ "Get simulation details:" ] }, { "cell_type": "code", "execution_count": 8, "id": "maritime-poetry", "metadata": {}, "outputs": [ { "data": { "text/plain": [ "{'api_url': '/hdoupe/Matchups/api/v1/94/',\n", " 'authors': ['hdoupe'],\n", " 'creation_date': '2021-02-08T15:01:37.569658Z',\n", " 'eta': 0.0,\n", " 'exp_comp_datetime': '2021-02-08T15:02:02.569658Z',\n", " 'gui_url': '/hdoupe/Matchups/94/',\n", " 'is_public': True,\n", " 'model_pk': 94,\n", " 'model_version': '2021',\n", " 'notify_on_completion': True,\n", " 'original_eta': 25.0,\n", " 'outputs': {'outputs': {'renderable': {'outputs': [{'id': 'fe088e7c-3ca1-481e-b962-0175010fb3bf',\n", " 'title': 'Walker Buehler v. All batters',\n", " 'filename': 'Walker Buehler v. All batters.json',\n", " 'media_type': 'bokeh',\n", " 'screenshot': 'https://compute.studio/storage/screenshots/fe088e7c-3ca1-481e-b962-0175010fb3bf.png'},\n", " {'id': '3a3f47b6-18ac-40e9-80a3-8dd5027b2a7a',\n", " 'title': 'Walker Buehler v. Freddie Freeman',\n", " 'filename': 'Walker Buehler v. Freddie Freeman.json',\n", " 'media_type': 'bokeh',\n", " 'screenshot': 'https://compute.studio/storage/screenshots/3a3f47b6-18ac-40e9-80a3-8dd5027b2a7a.png'},\n", " {'id': '5cf9599b-30a6-4685-a0c4-6f51e182eee3',\n", " 'title': 'Walker Buehler v. Ronald Acuna',\n", " 'filename': 'Walker Buehler v. Ronald Acuna.json',\n", " 'media_type': 'bokeh',\n", " 'screenshot': 'https://compute.studio/storage/screenshots/5cf9599b-30a6-4685-a0c4-6f51e182eee3.png'}],\n", " 'ziplocation': '0a10c8de-2b55-456c-80bf-bc42e86f1ef4_renderable.zip'},\n", " 'downloadable': {'outputs': [{'id': '87b40820-4e08-4392-89e3-61693044733c',\n", " 'title': 'Walker Buehler v. All batters',\n", " 'filename': 'Walker Buehler v. All batters.csv',\n", " 'media_type': 'CSV'},\n", " {'id': '65d56ff8-c33c-4730-97b1-b63fa8b38949',\n", " 'title': 'Walker Buehler v. Freddie Freeman',\n", " 'filename': 'Walker Buehler v. Freddie Freeman.csv',\n", " 'media_type': 'CSV'},\n", " {'id': '5a7c118d-6174-4df3-8690-b0697399a327',\n", " 'title': 'Walker Buehler v. Ronald Acuna',\n", " 'filename': 'Walker Buehler v. Ronald Acuna.csv',\n", " 'media_type': 'CSV'}],\n", " 'ziplocation': '0a10c8de-2b55-456c-80bf-bc42e86f1ef4_downloadable.zip'}},\n", " 'version': 'v1'},\n", " 'owner': 'hdoupe',\n", " 'outputs_version': 'v1',\n", " 'project': {'app_location': None,\n", " 'title': 'Matchups',\n", " 'oneliner': 'Analyze pitcher-batter matchups over the last 10 years',\n", " 'description': \"[Matchups](https://github.com/hdoupe/Matchups) provides pitch data on pitcher and batter matchups.. Select a date range using the format YYYY-MM-DD. Keep in mind that Matchups only provides data on matchups going back to 2008. Two datasets are offered to run this model: one that only has the most recent season, 2018, and one that contains data on every single pitch going back to 2008. Next, select your favorite pitcher and some batters who he's faced in the past. Click submit to start analyzing the selected matchups!\",\n", " 'repo_url': 'https://github.com/hdoupe/Matchups',\n", " 'repo_tag': 'master',\n", " 'latest_tag': 'f0af41930298fa9950cef51b736b704b40bd31e8',\n", " 'exp_task_time': 25,\n", " 'server_cost': 0.06116,\n", " 'cpu': '2.0',\n", " 'memory': '6.0',\n", " 'listed': True,\n", " 'owner': 'hdoupe',\n", " 'cluster_type': 'single-core',\n", " 'sim_count': 94,\n", " 'status': 'running',\n", " 'user_count': 11,\n", " 'callable_name': None,\n", " 'tech': 'python-paramtools',\n", " 'is_public': True,\n", " 'has_write_access': True},\n", " 'readme': None,\n", " 'run_time': 29,\n", " 'status': 'SUCCESS',\n", " 'title': 'Walker Beuhler vs My Favorite Braves Players in 2020 NLCS',\n", " 'traceback': None,\n", " 'parent_sims': [],\n", " 'role': 'admin',\n", " 'pending_permissions': [],\n", " 'access': [{'is_owner': True, 'role': 'admin', 'username': 'hdoupe'}]}" ] }, "execution_count": 8, "metadata": {}, "output_type": "execute_result" } ], "source": [ "matchups.detail(response[\"model_pk\"])" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.1" } }, "nbformat": 4, "nbformat_minor": 5 }