service-capacity-modeling 0.2.0__tar.gz

service_capacity_modeling-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Netflix, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

service_capacity_modeling-0.2.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.2
+Name: service-capacity-modeling
+Version: 0.2.0
+Summary: Contains utilities for modeling database capacity on a cloud
+Author: Joseph Lynch
+Author-email: josephl@netflix.com
+License: Apache 2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>2.0
+Requires-Dist: scipy
+Requires-Dist: numpy
+Requires-Dist: importlib_resources; python_version < "3.7"
+Requires-Dist: isodate
+Provides-Extra: aws
+Requires-Dist: boto3; extra == "aws"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+# Service Capacity Modeling
+
+![Build Status](https://github.com/Netflix-Skunkworks/service-capacity-modeling/actions/workflows/python-build.yml/badge.svg)
+
+A generic toolkit for modeling capacity requirements in the cloud. Pricing
+information included in this repository are public prices.
+
+**NOTE**: Netflix confidential information should never enter this repo. Please
+remember this repository is public when making changes to it.
+
+## Trying it out
+
+Run the tests:
+```bash
+# Test the capacity planner on included netflix models
+$ tox -e py38
+
+# Run a single test with a debugger attached if the test fails
+$ .tox/py38/bin/pytest -n0 -k test_java_heap_heavy --pdb --pdbcls=IPython.terminal.debugger:Pdb
+
+# Verify all type contracts
+$ tox -e mypy
+```
+
+Run IPython for interactively using the library:
+```
+tox -e dev -- ipython
+```
+
+## Example of Provisioning a Database
+Fire up ipython and let's capacity plan a Tier 1 (important to the product aka
+"prod") Cassandra database.
+
+```python
+from service_capacity_modeling.interface import CapacityDesires
+from service_capacity_modeling.interface import FixedInterval, Interval
+from service_capacity_modeling.interface import QueryPattern, DataShape
+
+db_desires = CapacityDesires(
+    # This service is important to the business, not critical (tier 0)
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 10,000 reads and 10,000 writes per second.
+        estimated_read_per_second=Interval(
+            low=1000, mid=10000, high=100000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=1000, mid=10000, high=100000, confidence=0.9
+        ),
+    ),
+    # Not sure how much data, but we think it'll be below 1 TiB
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=100, high=1000, confidence=0.9),
+    ),
+)
+```
+
+Now we can load up some models and do some capacity planning
+
+```python
+from service_capacity_modeling.capacity_planner import planner
+from service_capacity_modeling.models.org import netflix
+import pprint
+
+# Load up the Netflix capacity models
+planner.register_group(netflix.models)
+
+cap_plan = planner.plan(
+    model_name="org.netflix.cassandra",
+    region="us-east-1",
+    desires=db_desires,
+    # Simulate the possible requirements 512 times
+    simulations=512,
+    # Request 3 diverse hardware families to be returned
+    num_results=3,
+)
+
+# The range of requirements in hardware resources (CPU, RAM, Disk, etc ...)
+requirements = cap_plan.requirements
+
+# The ordered list of least regretful choices for the requirement
+least_regret = cap_plan.least_regret
+
+# Show the range of requirements for a single zone
+pprint.pprint(requirements.zonal[0].model_dump())
+
+# Show our least regretful choices of hardware in least regret order
+# So for example if we can buy the first set of computers we would prefer
+# to do that but we might not have availability in that family in which
+# case we'd buy the second one.
+for choice in range(3):
+    num_clusters = len(least_regret[choice].candidate_clusters.zonal)
+    print(f"Our #{choice + 1} choice is {num_clusters} zones of:")
+    pprint.pprint(least_regret[choice].candidate_clusters.zonal[0].model_dump())
+
+```
+
+Note that we _can_ customize more information given what we know about the
+use case, but each model (e.g. Cassandra) supplies reasonable defaults.
+
+For example we can specify a lot more information
+
+```python
+from service_capacity_modeling.interface import CapacityDesires, QueryPattern, Interval, FixedInterval, DataShape
+
+db_desires = CapacityDesires(
+    # This service is important to the business, not critical (tier 0)
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 50,000 reads and 45,000 writes per second with a rather narrow
+        # bound
+        estimated_read_per_second=Interval(
+            low=40_000, mid=50_000, high=60_000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=42_000, mid=45_000, high=50_000, confidence=0.9
+        ),
+        # This use case might do some partition scan queries that are
+        # somewhat expensive, so we hint a rather expensive ON-CPU time
+        # that a read will consume on the entire cluster.
+        estimated_mean_read_latency_ms=Interval(
+            low=0.1, mid=4, high=20, confidence=0.9
+        ),
+        # Writes at LOCAL_ONE are pretty cheap
+        estimated_mean_write_latency_ms=Interval(
+            low=0.1, mid=0.4, high=0.8, confidence=0.9
+        ),
+        # We want single digit latency, note that this is not a p99 of 10ms
+        # but defines the interval where 98% of latency falls to be between
+        # 0.4 and 10 milliseconds. Think of:
+        #   low = "the minimum reasonable latency"
+        #   high = "the maximum reasonable latency"
+        #   mid = "value between low and high such that I want my distribution
+        #          to skew left or right"
+        read_latency_slo_ms=FixedInterval(
+            low=0.4, mid=4, high=10, confidence=0.98
+        ),
+        write_latency_slo_ms=FixedInterval(
+            low=0.4, mid=4, high=10, confidence=0.98
+        )
+    ),
+    # Not sure how much data, but we think it'll be below 1 TiB
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=500, high=1000, confidence=0.9),
+    ),
+)
+```
+
+## Example of provisioning a caching cluster
+
+In this example we tweak the QPS up, on CPU time of operations down
+and SLO down. This more closely approximates a caching workload
+
+```python
+from service_capacity_modeling.interface import CapacityDesires, QueryPattern, Interval, FixedInterval, DataShape
+from service_capacity_modeling.capacity_planner import planner
+
+cache_desires = CapacityDesires(
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 10,000 reads and 10,000 writes per second.
+        estimated_read_per_second=Interval(
+            low=10_000, mid=100_000, high=1_000_000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=1_000, mid=20_000, high=100_000, confidence=0.9
+        ),
+        # Memcache is consistently fast at queries
+        estimated_mean_read_latency_ms=Interval(
+            low=0.05, mid=0.2, high=0.4, confidence=0.9
+        ),
+        estimated_mean_write_latency_ms=Interval(
+            low=0.05, mid=0.2, high=0.4, confidence=0.9
+        ),
+        # Caches usually have tighter SLOs
+        read_latency_slo_ms=FixedInterval(
+            low=0.4, mid=0.5, high=5, confidence=0.98
+        ),
+        write_latency_slo_ms=FixedInterval(
+            low=0.4, mid=0.5, high=5, confidence=0.98
+        )
+    ),
+    # Not sure how much data, but we think it'll be below 1000
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=200, high=500, confidence=0.9),
+    ),
+)
+
+cache_cap_plan = planner.plan(
+    model_name="org.netflix.cassandra",
+    region="us-east-1",
+    desires=cache_desires,
+    allow_gp2=True,
+)
+
+requirement = cache_cap_plan.requirement
+least_regret = cache_cap_plan.least_regret
+```
+
+## Notebooks
+
+We have a demo notebook in `notebooks` you can use to experiment. Start it with
+
+```
+tox -e notebook -- jupyter notebook notebooks/demo.ipynb
+```
+
+## Development
+
+To contribute to this project:
+
+1. Make your change in a branch. Consider making a new model if you are making
+   significant changes and registering it as a different name.
+2. Write a unit test using `pytest` in the `tests` folder.
+3. Ensure your tests pass via `tox` or debug them with:
+```
+tox -e py38 -- -k test_<your_functionality> --pdb --pdbcls=IPython.terminal.debugger:Pdb
+```
+
+### PyCharm IDE Setup
+Use one of the test environments for IDE development, e.g. `tox -e py310` and then
+`Add New Interpreter -> Add Local -> Select Existing -> Navigate to (workdir)/.tox/py310`.
+
+### Running CLIs
+Use the `dev` virtual environment via `tox -e dev`. Then execute CLIs via that env.
+
+## Release
+Tag to release, and Github actions should publish to upstream pypi. The internal Netflix mirrors will then
+pull it down.

service_capacity_modeling-0.2.0/README.md

@@ -0,0 +1,232 @@
+# Service Capacity Modeling
+
+![Build Status](https://github.com/Netflix-Skunkworks/service-capacity-modeling/actions/workflows/python-build.yml/badge.svg)
+
+A generic toolkit for modeling capacity requirements in the cloud. Pricing
+information included in this repository are public prices.
+
+**NOTE**: Netflix confidential information should never enter this repo. Please
+remember this repository is public when making changes to it.
+
+## Trying it out
+
+Run the tests:
+```bash
+# Test the capacity planner on included netflix models
+$ tox -e py38
+
+# Run a single test with a debugger attached if the test fails
+$ .tox/py38/bin/pytest -n0 -k test_java_heap_heavy --pdb --pdbcls=IPython.terminal.debugger:Pdb
+
+# Verify all type contracts
+$ tox -e mypy
+```
+
+Run IPython for interactively using the library:
+```
+tox -e dev -- ipython
+```
+
+## Example of Provisioning a Database
+Fire up ipython and let's capacity plan a Tier 1 (important to the product aka
+"prod") Cassandra database.
+
+```python
+from service_capacity_modeling.interface import CapacityDesires
+from service_capacity_modeling.interface import FixedInterval, Interval
+from service_capacity_modeling.interface import QueryPattern, DataShape
+
+db_desires = CapacityDesires(
+    # This service is important to the business, not critical (tier 0)
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 10,000 reads and 10,000 writes per second.
+        estimated_read_per_second=Interval(
+            low=1000, mid=10000, high=100000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=1000, mid=10000, high=100000, confidence=0.9
+        ),
+    ),
+    # Not sure how much data, but we think it'll be below 1 TiB
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=100, high=1000, confidence=0.9),
+    ),
+)
+```
+
+Now we can load up some models and do some capacity planning
+
+```python
+from service_capacity_modeling.capacity_planner import planner
+from service_capacity_modeling.models.org import netflix
+import pprint
+
+# Load up the Netflix capacity models
+planner.register_group(netflix.models)
+
+cap_plan = planner.plan(
+    model_name="org.netflix.cassandra",
+    region="us-east-1",
+    desires=db_desires,
+    # Simulate the possible requirements 512 times
+    simulations=512,
+    # Request 3 diverse hardware families to be returned
+    num_results=3,
+)
+
+# The range of requirements in hardware resources (CPU, RAM, Disk, etc ...)
+requirements = cap_plan.requirements
+
+# The ordered list of least regretful choices for the requirement
+least_regret = cap_plan.least_regret
+
+# Show the range of requirements for a single zone
+pprint.pprint(requirements.zonal[0].model_dump())
+
+# Show our least regretful choices of hardware in least regret order
+# So for example if we can buy the first set of computers we would prefer
+# to do that but we might not have availability in that family in which
+# case we'd buy the second one.
+for choice in range(3):
+    num_clusters = len(least_regret[choice].candidate_clusters.zonal)
+    print(f"Our #{choice + 1} choice is {num_clusters} zones of:")
+    pprint.pprint(least_regret[choice].candidate_clusters.zonal[0].model_dump())
+
+```
+
+Note that we _can_ customize more information given what we know about the
+use case, but each model (e.g. Cassandra) supplies reasonable defaults.
+
+For example we can specify a lot more information
+
+```python
+from service_capacity_modeling.interface import CapacityDesires, QueryPattern, Interval, FixedInterval, DataShape
+
+db_desires = CapacityDesires(
+    # This service is important to the business, not critical (tier 0)
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 50,000 reads and 45,000 writes per second with a rather narrow
+        # bound
+        estimated_read_per_second=Interval(
+            low=40_000, mid=50_000, high=60_000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=42_000, mid=45_000, high=50_000, confidence=0.9
+        ),
+        # This use case might do some partition scan queries that are
+        # somewhat expensive, so we hint a rather expensive ON-CPU time
+        # that a read will consume on the entire cluster.
+        estimated_mean_read_latency_ms=Interval(
+            low=0.1, mid=4, high=20, confidence=0.9
+        ),
+        # Writes at LOCAL_ONE are pretty cheap
+        estimated_mean_write_latency_ms=Interval(
+            low=0.1, mid=0.4, high=0.8, confidence=0.9
+        ),
+        # We want single digit latency, note that this is not a p99 of 10ms
+        # but defines the interval where 98% of latency falls to be between
+        # 0.4 and 10 milliseconds. Think of:
+        #   low = "the minimum reasonable latency"
+        #   high = "the maximum reasonable latency"
+        #   mid = "value between low and high such that I want my distribution
+        #          to skew left or right"
+        read_latency_slo_ms=FixedInterval(
+            low=0.4, mid=4, high=10, confidence=0.98
+        ),
+        write_latency_slo_ms=FixedInterval(
+            low=0.4, mid=4, high=10, confidence=0.98
+        )
+    ),
+    # Not sure how much data, but we think it'll be below 1 TiB
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=500, high=1000, confidence=0.9),
+    ),
+)
+```
+
+## Example of provisioning a caching cluster
+
+In this example we tweak the QPS up, on CPU time of operations down
+and SLO down. This more closely approximates a caching workload
+
+```python
+from service_capacity_modeling.interface import CapacityDesires, QueryPattern, Interval, FixedInterval, DataShape
+from service_capacity_modeling.capacity_planner import planner
+
+cache_desires = CapacityDesires(
+    service_tier=1,
+    query_pattern=QueryPattern(
+        # Not sure exactly how much QPS we will do, but we think around
+        # 10,000 reads and 10,000 writes per second.
+        estimated_read_per_second=Interval(
+            low=10_000, mid=100_000, high=1_000_000, confidence=0.9
+        ),
+        estimated_write_per_second=Interval(
+            low=1_000, mid=20_000, high=100_000, confidence=0.9
+        ),
+        # Memcache is consistently fast at queries
+        estimated_mean_read_latency_ms=Interval(
+            low=0.05, mid=0.2, high=0.4, confidence=0.9
+        ),
+        estimated_mean_write_latency_ms=Interval(
+            low=0.05, mid=0.2, high=0.4, confidence=0.9
+        ),
+        # Caches usually have tighter SLOs
+        read_latency_slo_ms=FixedInterval(
+            low=0.4, mid=0.5, high=5, confidence=0.98
+        ),
+        write_latency_slo_ms=FixedInterval(
+            low=0.4, mid=0.5, high=5, confidence=0.98
+        )
+    ),
+    # Not sure how much data, but we think it'll be below 1000
+    data_shape=DataShape(
+        estimated_state_size_gib=Interval(low=100, mid=200, high=500, confidence=0.9),
+    ),
+)
+
+cache_cap_plan = planner.plan(
+    model_name="org.netflix.cassandra",
+    region="us-east-1",
+    desires=cache_desires,
+    allow_gp2=True,
+)
+
+requirement = cache_cap_plan.requirement
+least_regret = cache_cap_plan.least_regret
+```
+
+## Notebooks
+
+We have a demo notebook in `notebooks` you can use to experiment. Start it with
+
+```
+tox -e notebook -- jupyter notebook notebooks/demo.ipynb
+```
+
+## Development
+
+To contribute to this project:
+
+1. Make your change in a branch. Consider making a new model if you are making
+   significant changes and registering it as a different name.
+2. Write a unit test using `pytest` in the `tests` folder.
+3. Ensure your tests pass via `tox` or debug them with:
+```
+tox -e py38 -- -k test_<your_functionality> --pdb --pdbcls=IPython.terminal.debugger:Pdb
+```
+
+### PyCharm IDE Setup
+Use one of the test environments for IDE development, e.g. `tox -e py310` and then
+`Add New Interpreter -> Add Local -> Select Existing -> Navigate to (workdir)/.tox/py310`.
+
+### Running CLIs
+Use the `dev` virtual environment via `tox -e dev`. Then execute CLIs via that env.
+
+## Release
+Tag to release, and Github actions should publish to upstream pypi. The internal Netflix mirrors will then
+pull it down.