triple-alpha 0.2.3__py3-none-any.whl

triple_alpha-0.2.3.dist-info/METADATA

@@ -0,0 +1,454 @@
+Metadata-Version: 2.4
+Name: triple-alpha
+Version: 0.2.3
+Summary: Package allows users to run jobs against the triple alpha system
+License: Apache2.0
+License-File: LICENSE
+Author: Rahul Suresh
+Author-email: rahul@horizonquantum.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Provides-Extra: json-logging
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: pydantic (>=2.13.4,<3.0.0)
+Requires-Dist: requests (>=2.33.0,<3.0.0)
+Requires-Dist: setuptools (>=83.0.0,<84.0.0)
+Project-URL: Homepage, https://github.com/horizon-quantum/triple-alpha
+Project-URL: Issues, https://github.com/horizon-quantum/triple-alpha/issues
+Description-Content-Type: text/markdown
+
+# Triple Alpha Deployment API – Python client
+
+Triple Alpha lets you write quantum programs in our languages (Beryllium, Helium and Hydrogen) and deploy a compiled program as an API (your deployment API). This package is the official Python client for your deployment API. With this package, you can:
+
+1. Submit jobs
+2. Check the status of your jobs
+3. Provide inputs for your jobs
+4. Retrieve results
+5. Run the above operations as batches.
+
+---
+
+## Table of contents
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [About the client](#about-the-client)
+- [License](#license)
+- [Quickstart](#quickstart)
+    - [1. Synchronous Runner](#1-synchronous-runner)
+        - [1.1. Creating a job](#11-creating-a-job)
+        - [1.2. Getting job status and results](#12-getting-job-status-and-results)
+        - [1.3. Updating inputs](#13-updating-inputs)
+        - [1.4. Canceling a job](#14-canceling-a-job)
+        - [1.5. Listing jobs](#15-listing-jobs)
+    - [2. Asynchronous Runner](#2-asynchronous-runner)
+        - [2.1. Creating a job](#21-creating-a-job)
+        - [2.2. Getting job status and results](#22-getting-job-status-and-results)
+        - [2.3. Updating inputs](#23-updating-inputs)
+        - [2.4. Canceling a job](#24-canceling-a-job)
+        - [2.5. Listing jobs](#25-listing-jobs)
+    - [3. Run Manager](#3-run-manager)
+        - [3.1. Submitting jobs](#31-submitting-jobs)
+        - [3.2. Listing jobs](#32-listing-jobs)
+        - [3.3. Getting job status](#33-getting-job-status)
+        - [3.4. Updating inputs](#34-updating-inputs)
+        - [3.5. Canceling jobs](#35-canceling-jobs)
+        - [3.6. Registering callbacks](#36-registering-callbacks)
+
+## Prerequisites
+Before using this client, ensure you have:
+* Python 3.11 or higher
+* A **deployment API**, created in Triple Alpha as part of successfully deploying your program. This client only works with an existing deployment API.
+* Your deployment API's **URL** and **API token**. These are shown once you have successfully deployed your program. The URL is also available from the API dashboard.
+
+## Installation
+
+Install the package via `pip`:
+
+```bash
+pip install triple-alpha
+```
+
+The package is imported as `triplealpha`:
+
+```python
+import triplealpha
+```
+
+## About the client
+Each deployment API exposes six endpoints, and this client wraps them 1:1:
+
+| Client method | Endpoint | Purpose |
+|---|---|---|
+| `run_execution` | `/run/create` | Submit a job to the processor or simulator |
+| `get_job_status` | `/run/get_status` | Get a job's status |
+| `get_job_results` | `/run/get_results` | Retrieve results of a completed job |
+| `update_inputs` | `/run/update_input` | Supply inputs to a job that is **Awaiting input** |
+| `cancel_execution` | `/run/cancel` | Cancel a submitted job |
+| `get_job_list` | `/run/list_jobs` | List job IDs and statuses for this deployment API |
+
+* Two runners expose the same methods against a deployment API: the **Synchronous Runner** for blocking calls, and the **Asynchronous Runner** for non-blocking versions of the same methods (built on `asyncio`).
+* Use a runner for individual jobs. For batches, use the **Run Manager**. It is a job orchestrator that queues jobs, limits how many are polled at once, throttles requests to stay within API rate limits, and polls for status updates. If you need custom polling logic, you can build it on the runners directly.
+* The Run Manager can also run a **callback** when a job reaches a given status. For example, you can supply inputs automatically when a job becomes **Awaiting input**. See [3.6. Registering callbacks](#36-registering-callbacks) for more information.
+* Job statuses are exposed as the `JobStatus` enum:
+
+| `JobStatus` | Status in Triple Alpha | Definition |
+|---|---|---|
+| `CREATED` | Created | The job is successfully created. |
+| `QUEUED` | Queued | The job is queued for processing on our servers. |
+| `IN_PROGRESS` | In progress | The job is being processed. Cancellation may still be possible at this stage. |
+| `AWAITING_QPU` | Awaiting QPU | The job has been submitted to the hardware provider. This status covers both queueing and running on the provider's QPU or simulator. Cancellation is not possible once a QPU job has started. |
+| `IN_FLIGHT` | In flight | The job has returned from the hardware provider and is awaiting post-processing on our servers. |
+| `AWAITING_INPUT` | Awaiting input | The job is paused, waiting for an input value to continue. This happens when your program uses user input or mid-circuit measurements that require interactive resolution. Provide it with `update_inputs`.|
+| `SUCCESSFUL` | Successful | The job completed successfully. Retrieve results with `get_job_results`.|
+| `CANCELLED` | Cancelled | The job was cancelled. |
+| `FAILED` | Failed | The job failed. |
+
+
+## License
+This client is distributed under the Apache 2.0 License. See LICENSE for more information.
+
+
+## Quickstart
+Every example needs your deployment API's URL and API token (see [Prerequisites](#prerequisites)). You can replace the placeholders with your own values.
+
+---
+### 1. Synchronous Runner
+Use the Synchronous Runner when blocking calls are fine (e.g scripts, notebooks and simple pipelines). It provides the following methods:
+
+#### 1.1. Creating a job
+
+```python
+import json
+
+# Import the Synchronous Runner
+from triplealpha import SynchronousRunner, JobStatus
+from triplealpha.models.service import Deployment
+from triplealpha.utils.logging import logger
+from triplealpha.utils.utils import serialize_json
+
+# Your deployment API's URL and API token, from the "API successfully created" window
+# shown after deployment (the URL is also available later in the API dashboard).
+api_url = "https://quark-prod-spin-api.horizonquantum.com/execute-api/deployment/{deployment_id}/processor/{processor_name}/run/{endpoint}"
+api_token = "{API token you get from the UI}"
+
+runner = SynchronousRunner(api_url=api_url, api_token=api_token)
+
+# num_shots is the number of complete runs of your program. If it exceeds the
+# "Max. shots per call" set when the API was deployed, it is capped at that value.
+# inputs is optional. Refer to 1.3 for the formats.
+run_payload = {"inputs": [], "num_shots": 100}
+response = runner.run_execution(payload=run_payload)
+logger.info(f"Job created. Response: {response}")
+created_job_id = response["job_id"]
+
+# Alternatively, wrap the URL and API token in a Deployment object. It validates the
+# URL format and can be reused across runners.
+deployment = Deployment(api_url=api_url, api_token=api_token)
+response = SynchronousRunner(deployment=deployment).run_execution(payload=run_payload)
+logger.info(f"Job created. Response: {response}")
+```
+
+#### 1.2. Getting job status and results
+
+```python
+# Get the job status (use this to implement polling logic).
+# serialize_json handles the objects in the responses when printing.
+response = runner.get_job_status(job_id=created_job_id)
+logger.info(
+    f"Job status. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+
+# Get the job results. Results are available once the job is SUCCESSFUL and contain
+# the values of variables flagged with `output` in your program, along with the measurement results.
+response = runner.get_job_results(job_id=created_job_id)
+logger.info(
+    f"Job results. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+
+#### 1.3. Updating inputs
+A job that needs an input value to continue will return the status **Awaiting input** (`JobStatus.AWAITING_INPUT`). Supply the inputs with `update_inputs` and the job will resume.
+
+```python
+# Inputs as a dict, or as a list of [name, value] pairs (the format used by the API and the UI).
+# Names must match the variables flagged with `input` in your program and are case-sensitive.
+# Values are classical floats.
+inputs = {"theta": 1.5708, "phi": 0.0}
+# inputs = [["theta", 1.5708], ["phi", 0.0]]
+
+# update_inputs only succeeds while the job is AWAITING_INPUT.
+try:
+    response = runner.update_inputs(job_id=created_job_id, inputs=inputs)
+    logger.info(
+        f"Updated inputs. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+    )
+except Exception as e:
+    logger.error(f"Update inputs failed: {e}")
+```
+
+#### 1.4. Canceling a job
+Canceling a job is handled on a best-effort basis. A job that is already running on a QPU may complete and still incur cost, particularly if the program uses mid-circuit measurement.
+
+```python
+response = runner.cancel_execution(job_id=created_job_id)
+logger.info(
+    f"Cancelled job. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+
+#### 1.5. Listing jobs
+
+
+```python
+# List all jobs associated with this deployment API
+response = runner.get_job_list()
+logger.info(
+    f"Job list. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+
+# Filter by status using the JobStatus enum (see "About the client" for the full list)
+response = runner.get_job_list(status=JobStatus.CANCELLED)
+logger.info(f"Job list. {json.dumps(response, indent=2, default=serialize_json)}")
+```
+
+### 2. Asynchronous Runner
+Use the Asynchronous Runner to call your deployment API in a non-blocking manner (built on `asyncio`). It exposes the same methods as the Synchronous Runner as coroutines.
+
+All snippets in this section must run inside a coroutine:
+
+```python
+import asyncio
+
+async def main():
+    ...  # snippets from 2.1–2.5 go here
+
+asyncio.run(main())
+```
+
+#### 2.1. Creating a job
+
+```python
+import json
+
+# Import the Asynchronous Runner
+from triplealpha import AsynchronousRunner, JobStatus
+from triplealpha.models.service import Deployment
+from triplealpha.utils.logging import logger
+from triplealpha.utils.utils import serialize_json
+
+# Your deployment API's URL and API token, from the "API successfully created" window
+# shown after deployment (the URL is also available later in the API dashboard).
+api_url = "https://quark-prod-spin-api.horizonquantum.com/execute-api/deployment/{deployment_id}/processor/{processor_name}/run/{endpoint}"
+api_token = "{API token you get from the UI}"
+
+async_runner = AsynchronousRunner(api_url=api_url, api_token=api_token)
+
+run_payload = {"inputs": [], "num_shots": 100}
+response = await async_runner.run_execution(payload=run_payload)
+logger.info(f"Job created. Response: {response}")
+async_created_job_id = response["job_id"]
+```
+
+#### 2.2. Getting job status and results
+
+
+```python
+response = await async_runner.get_job_status(job_id=async_created_job_id)
+logger.info(
+    f"Job status. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+
+response = await async_runner.get_job_results(job_id=async_created_job_id)
+logger.info(
+    f"Job results. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+
+#### 2.3. Updating inputs
+
+
+```python
+inputs = {"theta": 1.5708, "phi": 0.0}
+# inputs = [["theta", 1.5708], ["phi", 0.0]]
+
+# update_inputs only succeeds while the job is AWAITING_INPUT.
+try:
+    response = await async_runner.update_inputs(
+        job_id=async_created_job_id, inputs=inputs
+    )
+    logger.info(
+        f"Updated inputs. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+    )
+except Exception as e:
+    logger.error(f"Update inputs failed: {e}")
+```
+
+#### 2.4. Canceling a job
+
+```python
+response = await async_runner.cancel_execution(job_id=async_created_job_id)
+logger.info(
+    f"Cancelled job. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+
+#### 2.5. Listing jobs
+
+```python
+response = await async_runner.get_job_list()
+logger.info(
+    f"Job list. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+
+response = await async_runner.get_job_list(status=JobStatus.CANCELLED)
+logger.info(f"Job list. {json.dumps(response, indent=2, default=serialize_json)}")
+```
+
+### 3. Run Manager
+The Run Manager is the recommended way to run batches of jobs against a deployment API. It is an orchestrator: it queues jobs, limits concurrency, polls for status changes, and runs callbacks when a job reaches a given status.
+
+Points to note:
+
+* Only 25 jobs can be **active** (being polled for status updates) at any time, and the rest wait in the queue. There is no client-imposed limit on the number of queued jobs.
+* You can register callbacks per job to automate actions on status changes — e.g. update a job's inputs when it changes to `AWAITING_INPUT`.
+* The Run Manager holds job state **in memory only**. When the process exits, the manager forgets its queued and active jobs, and the jobs themselves continue on Triple Alpha. You will need to persist job IDs if you need to resume monitoring in a new process, and the methods below accept job IDs so you can continue work.
+* The Run Manager is `asyncio`-based. All its methods are coroutines and must be called from within a running event loop (see the wrapper in [2. Asynchronous Runner](#2-asynchronous-runner)).
+
+
+#### 3.1. Submitting jobs
+
+```python
+import json
+
+from triplealpha import JobStatus
+from triplealpha.deployment.orchestrator.run_manager import RunManager
+from triplealpha.utils.logging import logger
+from triplealpha.utils.utils import serialize_json
+
+# No arguments are required to create the manager
+manager = RunManager()
+```
+Each job payload carries the deployment API's URL and API token, the job parameters, and (optionally) callbacks:
+
+```python
+job_payload = {
+    "api_url": "https://quark-prod-spin-api.horizonquantum.com/execute-api/deployment/{deployment_id}/processor/{processor_key}/run/create",
+    "api_token": "{API token you get from the UI}",
+    "inputs": [],
+    "num_shots": 100,
+    "callbacks": {},
+}
+
+# Submit one job
+response = await manager.submit_job(job_payload=job_payload)
+logger.info(
+    f"Job submitted to manager. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+job_id = response["job_id"]
+
+# Submit a batch – e.g. the same program over a sweep of input values
+for theta in (0.0, 0.5, 1.0):
+    await manager.submit_job(job_payload={**job_payload, "inputs": [["theta", theta]]})
+```
+
+#### 3.2. Listing jobs
+
+```python
+queued_jobs = manager.queued_jobs
+if len(queued_jobs) > 0:
+    logger.info(f"Jobs in queue: {queued_jobs}")
+
+active_jobs = manager.active_jobs
+if len(active_jobs) > 0:
+    logger.info(f"Jobs in active monitoring: {active_jobs}")
+
+failed_jobs = manager.failed_jobs
+if len(failed_jobs) > 0:
+    logger.info(f"Failed jobs: {failed_jobs}")
+
+cancelled_jobs = manager.cancelled_jobs
+if len(cancelled_jobs) > 0:
+    logger.info(f"Cancelled jobs: {cancelled_jobs}")
+
+successful_jobs = manager.successful_jobs
+if len(successful_jobs) > 0:
+    logger.info(f"Successful jobs: {successful_jobs}")
+```
+
+#### 3.3. Getting job status
+
+```python
+response = await manager.get_job_status(
+    job_ids=[job_id],
+)
+logger.info(
+    f"Job status. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+
+#### 3.4. Updating inputs
+Update inputs for one or more jobs in a single call:
+
+```python
+inputs_payload = [
+    {
+        "job_id": job_id,
+        "inputs": {"theta": 1.5708, "phi": 0.0},
+    }
+]
+
+response = await manager.update_inputs(inputs_payload=inputs_payload)
+logger.info(response)
+```
+
+#### 3.5. Canceling jobs
+Canceling a job is handled on a best-effort basis, as mentioned in [1.4. Canceling a job](#14-canceling-a-job).
+
+```python
+response = await manager.cancel_job(job_ids=[job_id])
+logger.info(response)
+```
+
+#### 3.6. Registering callbacks
+
+* A callback is a coroutine the Run Manager runs when a job enters a given status. Register callbacks per job at submission, keyed by `JobStatus`. The callback receives the job object.
+* The most useful callback is on `AWAITING_INPUT`: supply the job's inputs automatically so the batch proceeds without manual intervention.
+
+```python
+# Sample callbacks
+async def supply_inputs(job):
+    # Runs when the job reaches AWAITING_INPUT
+    await manager.update_inputs(
+        inputs_payload=[{"job_id": job.job_id, "inputs": {"theta": 1.5708}}]
+    )
+
+async def print_success(job):
+    print(f"SUCCESS: {job.job_id} finished")
+
+job_payload = {
+    "api_url": "https://quark-prod-spin-api.horizonquantum.com/execute-api/deployment/{deployment_id}/processor/{processor_key}/run/create",
+    "api_token": "{API token you get from the UI}",
+    "inputs": [],
+    "num_shots": 100,
+    "callbacks": {
+        JobStatus.AWAITING_INPUT: supply_inputs,
+        JobStatus.SUCCESSFUL: print_success,
+    },
+}
+
+response = await manager.submit_job(job_payload=job_payload)
+logger.info(
+    f"Job submitted to manager. Response: {json.dumps(response, indent=2, default=serialize_json)}"
+)
+```
+

triple_alpha-0.2.3.dist-info/RECORD

@@ -0,0 +1,24 @@
+triplealpha/__init__.py,sha256=vEpbZuxcq-yr0zVt_VpsM-j0svRE-HQGGPKpTG9NGVo,1134
+triplealpha/deployment/__init__.py,sha256=ACc8ds9_bP3Xcbv7cfWkNHZ7x-SjDqzqu2PbrO4egPY,600
+triplealpha/deployment/orchestrator/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/deployment/orchestrator/run_manager.py,sha256=dBr0i9yTe_FPvMGMMLkfjYWn3el6AxO0IaVW4-VKMi4,22141
+triplealpha/deployment/runner/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/deployment/runner/asynchronous_runner.py,sha256=laUAbprqscHyzUCkrSrcJnR6wr-QIdctPPxLQUkNeds,6231
+triplealpha/deployment/runner/synchronous_runner.py,sha256=g0WKufJyhSWrWSH3SB-RonPQ_i_quxBgQkkYAAX2ko4,6042
+triplealpha/models/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/models/api/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/models/api/execution.py,sha256=ZnTX9Sb8-UUoJ73hdfPPJdXg8xb_h_gnE0oJICXAT4o,1924
+triplealpha/models/service/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/models/service/models.py,sha256=8d-mFTZqGkJa2l7iWnhh0dnzR0MmGWePHLmAbY4DxQ4,4435
+triplealpha/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+triplealpha/utils/__init__.py,sha256=RbogtvCxDdJ7D3VeJvPc_qbd4Ag5KjBacEbolUqcO6U,593
+triplealpha/utils/constants.py,sha256=4z0n2kDLvyOgABcd8XfkgDgFB7CRWfqK7zoGQ6LtL-M,1463
+triplealpha/utils/exceptions.py,sha256=AJ6phSfb5jnPhp4awPlWbfuPE_8HRBndB0awJL1n4ag,1044
+triplealpha/utils/logging.py,sha256=NNeE0MiIn7phmy341yYdg9PE_-edlNVFQ_vptobmQY0,2159
+triplealpha/utils/rest.py,sha256=N41hbZoi5mLpN4VZK1N7lv57l5405dVPQfMw78zzXUY,4798
+triplealpha/utils/rest_async.py,sha256=XiD3r8yCrDNsGWgoUcXe1fz6NsMYdCSDJWjeAu0vRQI,4784
+triplealpha/utils/utils.py,sha256=t-WPR3yg4B5PTZ5UM9T7kEgXcX7EnqBLJHV2KzJR_Bw,3498
+triple_alpha-0.2.3.dist-info/METADATA,sha256=TBEQTVM_fPOsgfQhuvo-SyAM7QhFUjQWWeGCcyLBytg,17804
+triple_alpha-0.2.3.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+triple_alpha-0.2.3.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+triple_alpha-0.2.3.dist-info/RECORD,,

triple_alpha-0.2.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.5.0
+Root-Is-Purelib: true
+Tag: py3-none-any

triple_alpha-0.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.