hyperscale


Namehyperscale JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/hyper-light/hyperscale
SummaryPerformance testing at scale.
upload_time2024-06-20 02:36:06
maintainerNone
docs_urlNone
authorSean Corbett
requires_python>=3.8
licenseNone
keywords pypi cicd python performance testing dag graph workflow
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# <b>Hyperscale</b>
[![PyPI version](https://img.shields.io/pypi/v/hyperscale?color=blue)](https://pypi.org/project/hyperscale/)
[![License](https://img.shields.io/github/license/hyper-light/hyperscale)](https://github.com/hyper-light/hyperscale/blob/main/LICENSE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/hyper-light/hyperscale/blob/main/CODE_OF_CONDUCT.md)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hyperscale?color=red)](https://pypi.org/project/hyperscale/)


| Package     | Hyperscale                                                      |
| ----------- | -----------                                                     |
| Version     | 0.1.0                                                           |
| Web         | https://hyperscale.dev                                          |
| Download    | https://pypi.org/project/hyperscale/                            | 
| Source      | https://github.com/hyper-light/hyperscale                       |
| Keywords    | performance, testing, async, distributed, graph, DAG, workflow  |

Hyperscale is a Python performance and scalable unit/integration testing framework that makes creating and running complex test workflows easy.

These workflows are written as directed acrylic graphs in Python, where each graph is specified as a collection of Python classes referred to as <b>stages</b>. Each Stage may then specify async Python methods which are then wrapped in Python decorators (referred to as <b>hooks</b>), which that Stage will then execute. The hook wrapping a method tells Hyperscale both what the action does and when to execute it. In combination, stages and hooks allow you to craft test workflows that can mimic real-world user behavior, optimize framework performance, or interact with a variety of Hyperscale's powerful integrations.

<br/>

___________

## <b> Why Hyperscale? </b>

Understanding how your application performs under load can provide valuable insights - allowing you to spot issues with latency, memory usage, and stability. However, performance test tools providing these insights are often difficult to use and lack the ability to simulate complex user interaction at scale. Hyperscale was built to solve these problems by allowing developers and test engineers to author performance tests as sophisticated and scalable workflows. Hyperscale adheres to the following tenants:

<br/>

### __Speed and efficiency by default__ 

Regardless of whether running on your personal laptop or distributed across a cluster, Hyperscale is *fast*, capable of generating millions of requests or interactions per minute and without consuming excessive memory. Hyperscale pushes the limits of Python to achieve this, embracing the latest in Python async and multiprocessing language features to achieve optimal execution performance.

<br/>

### __Run with ease anywhere__

Authoring, managing, and running test workflows is easy. Hyperscale includes integrations with Git to facilitate easy management of collections of graphs via <b>Projects</b>, the ability to generate flexible starter test templates, and an API that is both fast and intuitive to understand. Distributed use almost exactly mirrors local operation, reducing the learning curve for more complex deployments.

<br/>

### __Flexibility and and painless extensibility__
Hyperscale ships with support for HTTP, HTTP2, Websockets, and UDP out of the box. GraphQL, GRPC, and Playwright are available simply by installing the (optional) dependency packages. Hyperscale offers JSON and CSV results output by default, with 28 additional results reporting options readily available by likewise installing the required dependencies.

Likewise, Hyperscale offers a comprehensive plugin system. You can easily write a plugin to test your Postgresql database or integrate a third party service, with CLI-generated templates to guide you and full type hints support throughout. Unlike other frameworks, no additional compilation or build steps are required - just write your plugin, import it, and include it in the appropriate Stage in your test graph.

<br/>

___________

## <b>Requirements and Getting Started</b>

Hyperscale has been tested on Python versions 3.8.6+, though we recommend using Python 3.10+. You should likewise have the latest LTS version of OpenSSL, build-essential, and other common Unix dependencies installed (if running on a Unix-based OS).

*<b>Warning</b>*: Hyperscale has currently only been tested on the latest LTS versions of Ubuntu and Debian. Other official OS support is coming Mar. 2023. 

<br/>

### __Installing__ 

To install Hyperscale run:
```
pip install hyperscale
```
Verify the installation was was successful by running the command:
```
hyperscale --help
```

which should output

![Output of the hyperscale --help command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_help_output.png?raw=true "Verifyin Install")

<br/>

### __Creating your first graph__ 

Get started by running Hyperscale's:
```
hyperscale graph create <path/to/graph_name.py>
```
command in an empty directory to generate a basic test from a template. For example, run:
```
hyperscale graph create example.py
```
which will output the following:

![Output of the hyperscale graph create example.py command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_create.png?raw=true "Creating a Graph")

and generate the the test below in the specified `example.py` file:
```python
from hyperscale import (
	Setup,
	Execute,
	action,
	Analyze,
	JSONConfig,
	Submit,
	depends,
)

class SetupStage(Setup):
    batch_size=1000
    total_time='1m'


@depends(SetupStage)
class ExecuteHTTPStage(Execute):

    @action()
    async def http_get(self):
        return await self.client.http.get('https://<url_here>')


@depends(ExecuteHTTPStage)
class AnalyzeStage(Analyze):
    pass


@depends(AnalyzeStage)
class SubmitJSONResultsStage(Submit):
    config=JSONConfig(
        events_filepath='./events.json',
        metrics_filepath='./metrics.json'
    )

```

We'll explain this graph below, but for now  - replace the string `'https://<url_here>'` with `'https://httpbin.org/get'`.

<br/>
Before running our test, if on a Unix system, we may need to set the maximum number of open files above its current limit. This can be done
by running:

```
ulimit -n 256000
```

note that you can provide any number here, as long as it is greater than the `batch_size` specified in the `SetupStage` Stage. With that, we're ready run our first test by executing:
```
hyperscale graph run example.py
```

Hyperscale will load the test graph file, parse/validate/setup the stages specified, then begin executing your test:

![Output of the hyperscale graph run example.py command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_run_example.png?raw=true "Running a Graph")

The test will take a minute or two to run, but once complete you should see:

![Output of hyperscale from a completed graph run](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_complete.png?raw=true "A Complete Graph Run")

You have officially created and run your first test graph!

<br/>


___________

## <b>Development</b>

Local development requires at-minimum Python 3.8.6, though 3.10.0+ is recommended. To setup your environment run:

```
python3 -m venv ~/.hyperscale && \
source ~/.hyperscale/bin/activate && \
git clone https://github.com/hyper-light/hyperscale.git && \
cd hyperscale && \
pip install --no-cache -r requirements.in && \
python setup.py develop
```

To develop or work with any of the additional provided engines, references the dependency tables below.

<br/>

___________

## <b>Engines, Personas, Algorithms, and Reporters</b>

Much of Hyperscale's extensibility comes in the form of both extensive integrations/options and plugin capabilities for four main framework features:
<br/>

### __Engines__ 
Engines are the underlying protocol or library integrations required for Hyperscale to performance test your application (for example HTTP, UDP, Playwright). Hyperscale currently supports the following Engines, with additional install requirements shown if necessary:

| Engine           | Additional Install Option                                       |  Dependencies                 |
| -----------      | -----------                                                     |------------                   |
| HTTP             | N/A                                                             | N/A                           |
| HTTP2            | N/A                                                             | N/A                           |
| HTTP3 (unstable) | pip install hyperscale[http3]                                   | aioquic                       |
| UDP              | N/A                                                             | N/A                           |
| Websocket        | N/A                                                             | N/A                           |
| GRPC             | pip install hyperscale[grpc]                                    | protobuf                      |
| GraphQL          | pip install hyperscale[graphql]                                 | graphql-core                  |
| GraphQL-HTTP2    | pip install hyperscale[graphql]                                 | graphql-core                  |
| Playwright       | pip install hyperscale[playwright] && playwright install        | playwright                    |


<br/>

### __Personas__

Personas are responsible for scheduling when `@action()` or `@task()` hooks execute over the specified Execute stage's test duration. No additional install dependencies are required for Personas, and the following personas are currently supported out-of-box:

| Persona               | Setup Config Name       | Description                                                                                                                                                                                                                         |
| ----------            | ----------------        | -----------------                                                                                                                                                               |
| Approximate Distribution (unstable) | approximate-distribution                 | Hyperscale automatically adjusts the batch size after each batch spawns according to the concurrency at the current distribution step. This Persona is only available to and is selected by default if a Variant of an Experiment is assigned a distribution.    |
| Batched               | batched                 | Executes each action or task hook in batches of the specified size, with an optional wait between each batch spawning                                                           |
| Constant Arrival Rate | constant-arrival        | Hyperscale automatically adjusts the batch size after each batch spawns based upon the number of hooks that have completed, attempting to achieve `batch_size` completions per batch |
| Constant Spawn Rate   | constant-spawn          | Like `Batched`, but cycles through actions before waiting `batch_interval` time.                                                                                                |
| Default               | N/A                     | Cycles through all action/task hooks in the Execute stage, resulting in a (mostly) even distribution of execution                                                               |
| No-Wait               | no-wait                 | Cycles through all action/task hooks in the Execute stage with no memory usage or other waits. __WARNING__: This persona may cause OOM.                                         |    
| Ramped                | ramped                  | Starts at a batch size of  `batch_gradient` * `batch_size`. Batch size increases by the gradient each batch with an optional wait between each batch spawning                   |
| Ramped Interval       | ramped-interval         | Executes `batch_size` hooks before waiting `batch_gradient` * `batch_interval` time. Interval increases by the gradient each batch                                              |
| Sorted                | sorted                  | Executes each action/task hook in batches of the specified size and in the order provided to each hook's (optional) `order` parameter                                           |
| Weighted              | weighted                | Executes action/task hooks in batches of the specified size, with each batch being generated from a sampled distribution based upon that action's weight                        |

<br/>

### __Algorithms__

Algorithms are used by Hyperscale `Optimize` stages to calculate maximal test config options like `batch_size`, `batch_gradient`, and/or `batch_interval`. All out-of-box supported algorithms use `scikit-learn` and include:

| Algorithm                   | Setup Config Name    | Description                                                                                                                          |
| ----------                  | ----------------     | -----------------                                                                                                                    |
| SHG                         | shg                  | Uses `scikit-learn`'s Simple Global Homology (SHGO) global optimization algorithm                                                    |
| Dual Annealing              | dual-annealing       | Uses `scikit-learn`'s Dual Annealing global optimization algorithm                                                                   |
| Differential Evolution      | diff-evolution       | Uses `scikit-learn`'s Differential Evolution global optimization algorithm                                                           |
| Point Optimizer (unstable)  | point-optimizer      | Uses a custom least-squares algorithm. Can only be used by assigning a distribution to a Variant stage for an Experiment.           |

<br/>

### __Reporters__

Reporters are the integrations Hyperscale uses for submitting aggregated and unaggregated results (for example, to a MySQL database via the MySQL reporter). Hyperscale currently supports the following Reporters, with additional install requirements shown if necessary:

| Engine               | Additional Install Option                                 |  Dependencies                            |
| -----------          | -----------                                               |------------                              |
| AWS Lambda           | pip install hyperscale[aws]                               | boto3                                    |
| AWS Timestream       | pip install hyperscale[aws]                               | boto3                                    |
| Big Query            | pip install hyperscale[google]                            | google-cloud-bigquery                    |
| Big Table            | pip install hyperscale[google]                            | google-cloud-bigtable                    |
| Cassandra            | pip install hyperscale[cassandra]                         | cassandra-driver                         |
| Cloudwatch           | pip install hyperscale[aws]                               | boto3                                    |
| CosmosDB             | pip install hyperscale[azure]                             | azure-cosmos                             |
| CSV                  | N/A                                                       | N/A                                      |
| Datadog              | pip install hyperscale[datadog]                           | datadog                                  |
| DogStatsD            | pip install hyperscale[statsd]                            | aio_statsd                               |
| Google Cloud Storage | pip install hyperscale[google]                            | google-cloud-storage                     |
| Graphite             | pip install hyperscale[statsd]                            | aio_statsd                               |
| Honeycomb            | pip install hyperscale[honeycomb]                         | libhoney                                 |
| InfluxDB             | pip install hyperscale[influxdb]                          | influxdb_client                          |
| JSON                 | N/A                                                       | N/A                                      |
| Kafka                | pip install hyperscale[kafka]                             | aiokafka                                 |
| MongoDB              | pip install hyperscale[mongodb]                           | motor                                    |
| MySQL                | pip install hyperscale[sql]                               | aiomysql, sqlalchemy                     |
| NetData              | pip install hyperscale[statsd]                            | aio_statsd                               |
| New Relic            | pip install hyperscale[newrelic]                          | newrelic                                 |
| Postgresql           | pip install hyperscale[sql]                               | aiopg, psycopg2-binary, sqlalchemy       |
| Prometheus           | pip install hyperscale[prometheus]                        | prometheus-client, prometheus-client-api |
| Redis                | pip install hyperscale[redis]                             | redis, aioredis                          |
| S3                   | pip install hyperscale[aws]                               | boto3                                    |
| Snowflake            | pip install hyperscale[snowflake]                         | snowflake-connector-python, sqlalchemy   |
| SQLite3              | pip install hyperscale[sql]                               | sqlalchemy                               |
| StatsD               | pip install hyperscale[statsd]                            | aio_statsd                               |
| Telegraf             | pip install hyperscale[statsd]                            | aio_statsd                               |
| TelegrafStatsD       | pip install hyperscale[statsd]                            | aio_statsd                               |
| TimescaleDB          | pip install hyperscale[sql]                               | aiopg, psycopg2-binary, sqlalchemy       |
| XML                  | pip install hyperscale[xml]                               | dicttoxml                                |

<br/>

___________

## <b>Resources</b>

Hyperscale's official and full documentation is currently being written and will be linked here soon!

___________

## <b>License</b>

This software is licensed under the MIT License. See the LICENSE file in the top distribution directory for the full license text.

___________

## <b>Contributing</b>

Hyperscale will be open to general contributions starting Fall, 2023 (once the distributed rewrite and general testing is complete). Until then, feel
free to use Hyperscale on your local machine and report any bugs or issues you find!

___________

## <b>Code of Conduct</b>

Hyperscale has adopted and follows the [Contributor Covenant code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md).
If you observe behavior that violates those rules please report to:

| Name            | Email                       | Twitter                                      |
|-------          |--------                     |----------                                    |
| Sean Corbett    | sean.corbett@umontana.edu   | [@sc_codeum](https://twitter.com/sc_codeUM/) |

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hyper-light/hyperscale",
    "name": "hyperscale",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "pypi, cicd, python, performance, testing, dag, graph, workflow",
    "author": "Sean Corbett",
    "author_email": "sean.corbett@umconnect.edu",
    "download_url": "https://files.pythonhosted.org/packages/95/92/d8aca4c1785621fcc0208c33438b7373232b39ed8a311d1773e85b966a19/hyperscale-0.1.5.tar.gz",
    "platform": null,
    "description": "\n# <b>Hyperscale</b>\n[![PyPI version](https://img.shields.io/pypi/v/hyperscale?color=blue)](https://pypi.org/project/hyperscale/)\n[![License](https://img.shields.io/github/license/hyper-light/hyperscale)](https://github.com/hyper-light/hyperscale/blob/main/LICENSE)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/hyper-light/hyperscale/blob/main/CODE_OF_CONDUCT.md)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hyperscale?color=red)](https://pypi.org/project/hyperscale/)\n\n\n| Package     | Hyperscale                                                      |\n| ----------- | -----------                                                     |\n| Version     | 0.1.0                                                           |\n| Web         | https://hyperscale.dev                                          |\n| Download    | https://pypi.org/project/hyperscale/                            | \n| Source      | https://github.com/hyper-light/hyperscale                       |\n| Keywords    | performance, testing, async, distributed, graph, DAG, workflow  |\n\nHyperscale is a Python performance and scalable unit/integration testing framework that makes creating and running complex test workflows easy.\n\nThese workflows are written as directed acrylic graphs in Python, where each graph is specified as a collection of Python classes referred to as <b>stages</b>. Each Stage may then specify async Python methods which are then wrapped in Python decorators (referred to as <b>hooks</b>), which that Stage will then execute. The hook wrapping a method tells Hyperscale both what the action does and when to execute it. In combination, stages and hooks allow you to craft test workflows that can mimic real-world user behavior, optimize framework performance, or interact with a variety of Hyperscale's powerful integrations.\n\n<br/>\n\n___________\n\n## <b> Why Hyperscale? </b>\n\nUnderstanding how your application performs under load can provide valuable insights - allowing you to spot issues with latency, memory usage, and stability. However, performance test tools providing these insights are often difficult to use and lack the ability to simulate complex user interaction at scale. Hyperscale was built to solve these problems by allowing developers and test engineers to author performance tests as sophisticated and scalable workflows. Hyperscale adheres to the following tenants:\n\n<br/>\n\n### __Speed and efficiency by default__ \n\nRegardless of whether running on your personal laptop or distributed across a cluster, Hyperscale is *fast*, capable of generating millions of requests or interactions per minute and without consuming excessive memory. Hyperscale pushes the limits of Python to achieve this, embracing the latest in Python async and multiprocessing language features to achieve optimal execution performance.\n\n<br/>\n\n### __Run with ease anywhere__\n\nAuthoring, managing, and running test workflows is easy. Hyperscale includes integrations with Git to facilitate easy management of collections of graphs via <b>Projects</b>, the ability to generate flexible starter test templates, and an API that is both fast and intuitive to understand. Distributed use almost exactly mirrors local operation, reducing the learning curve for more complex deployments.\n\n<br/>\n\n### __Flexibility and and painless extensibility__\nHyperscale ships with support for HTTP, HTTP2, Websockets, and UDP out of the box. GraphQL, GRPC, and Playwright are available simply by installing the (optional) dependency packages. Hyperscale offers JSON and CSV results output by default, with 28 additional results reporting options readily available by likewise installing the required dependencies.\n\nLikewise, Hyperscale offers a comprehensive plugin system. You can easily write a plugin to test your Postgresql database or integrate a third party service, with CLI-generated templates to guide you and full type hints support throughout. Unlike other frameworks, no additional compilation or build steps are required - just write your plugin, import it, and include it in the appropriate Stage in your test graph.\n\n<br/>\n\n___________\n\n## <b>Requirements and Getting Started</b>\n\nHyperscale has been tested on Python versions 3.8.6+, though we recommend using Python 3.10+. You should likewise have the latest LTS version of OpenSSL, build-essential, and other common Unix dependencies installed (if running on a Unix-based OS).\n\n*<b>Warning</b>*: Hyperscale has currently only been tested on the latest LTS versions of Ubuntu and Debian. Other official OS support is coming Mar. 2023. \n\n<br/>\n\n### __Installing__ \n\nTo install Hyperscale run:\n```\npip install hyperscale\n```\nVerify the installation was was successful by running the command:\n```\nhyperscale --help\n```\n\nwhich should output\n\n![Output of the hyperscale --help command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_help_output.png?raw=true \"Verifyin Install\")\n\n<br/>\n\n### __Creating your first graph__ \n\nGet started by running Hyperscale's:\n```\nhyperscale graph create <path/to/graph_name.py>\n```\ncommand in an empty directory to generate a basic test from a template. For example, run:\n```\nhyperscale graph create example.py\n```\nwhich will output the following:\n\n![Output of the hyperscale graph create example.py command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_create.png?raw=true \"Creating a Graph\")\n\nand generate the the test below in the specified `example.py` file:\n```python\nfrom hyperscale import (\n\tSetup,\n\tExecute,\n\taction,\n\tAnalyze,\n\tJSONConfig,\n\tSubmit,\n\tdepends,\n)\n\nclass SetupStage(Setup):\n    batch_size=1000\n    total_time='1m'\n\n\n@depends(SetupStage)\nclass ExecuteHTTPStage(Execute):\n\n    @action()\n    async def http_get(self):\n        return await self.client.http.get('https://<url_here>')\n\n\n@depends(ExecuteHTTPStage)\nclass AnalyzeStage(Analyze):\n    pass\n\n\n@depends(AnalyzeStage)\nclass SubmitJSONResultsStage(Submit):\n    config=JSONConfig(\n        events_filepath='./events.json',\n        metrics_filepath='./metrics.json'\n    )\n\n```\n\nWe'll explain this graph below, but for now  - replace the string `'https://<url_here>'` with `'https://httpbin.org/get'`.\n\n<br/>\nBefore running our test, if on a Unix system, we may need to set the maximum number of open files above its current limit. This can be done\nby running:\n\n```\nulimit -n 256000\n```\n\nnote that you can provide any number here, as long as it is greater than the `batch_size` specified in the `SetupStage` Stage. With that, we're ready run our first test by executing:\n```\nhyperscale graph run example.py\n```\n\nHyperscale will load the test graph file, parse/validate/setup the stages specified, then begin executing your test:\n\n![Output of the hyperscale graph run example.py command](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_run_example.png?raw=true \"Running a Graph\")\n\nThe test will take a minute or two to run, but once complete you should see:\n\n![Output of hyperscale from a completed graph run](https://github.com/hyper-light/hyperscale/blob/main/images/hedra_graph_complete.png?raw=true \"A Complete Graph Run\")\n\nYou have officially created and run your first test graph!\n\n<br/>\n\n\n___________\n\n## <b>Development</b>\n\nLocal development requires at-minimum Python 3.8.6, though 3.10.0+ is recommended. To setup your environment run:\n\n```\npython3 -m venv ~/.hyperscale && \\\nsource ~/.hyperscale/bin/activate && \\\ngit clone https://github.com/hyper-light/hyperscale.git && \\\ncd hyperscale && \\\npip install --no-cache -r requirements.in && \\\npython setup.py develop\n```\n\nTo develop or work with any of the additional provided engines, references the dependency tables below.\n\n<br/>\n\n___________\n\n## <b>Engines, Personas, Algorithms, and Reporters</b>\n\nMuch of Hyperscale's extensibility comes in the form of both extensive integrations/options and plugin capabilities for four main framework features:\n<br/>\n\n### __Engines__ \nEngines are the underlying protocol or library integrations required for Hyperscale to performance test your application (for example HTTP, UDP, Playwright). Hyperscale currently supports the following Engines, with additional install requirements shown if necessary:\n\n| Engine           | Additional Install Option                                       |  Dependencies                 |\n| -----------      | -----------                                                     |------------                   |\n| HTTP             | N/A                                                             | N/A                           |\n| HTTP2            | N/A                                                             | N/A                           |\n| HTTP3 (unstable) | pip install hyperscale[http3]                                   | aioquic                       |\n| UDP              | N/A                                                             | N/A                           |\n| Websocket        | N/A                                                             | N/A                           |\n| GRPC             | pip install hyperscale[grpc]                                    | protobuf                      |\n| GraphQL          | pip install hyperscale[graphql]                                 | graphql-core                  |\n| GraphQL-HTTP2    | pip install hyperscale[graphql]                                 | graphql-core                  |\n| Playwright       | pip install hyperscale[playwright] && playwright install        | playwright                    |\n\n\n<br/>\n\n### __Personas__\n\nPersonas are responsible for scheduling when `@action()` or `@task()` hooks execute over the specified Execute stage's test duration. No additional install dependencies are required for Personas, and the following personas are currently supported out-of-box:\n\n| Persona               | Setup Config Name       | Description                                                                                                                                                                                                                         |\n| ----------            | ----------------        | -----------------                                                                                                                                                               |\n| Approximate Distribution (unstable) | approximate-distribution                 | Hyperscale automatically adjusts the batch size after each batch spawns according to the concurrency at the current distribution step. This Persona is only available to and is selected by default if a Variant of an Experiment is assigned a distribution.    |\n| Batched               | batched                 | Executes each action or task hook in batches of the specified size, with an optional wait between each batch spawning                                                           |\n| Constant Arrival Rate | constant-arrival        | Hyperscale automatically adjusts the batch size after each batch spawns based upon the number of hooks that have completed, attempting to achieve `batch_size` completions per batch |\n| Constant Spawn Rate   | constant-spawn          | Like `Batched`, but cycles through actions before waiting `batch_interval` time.                                                                                                |\n| Default               | N/A                     | Cycles through all action/task hooks in the Execute stage, resulting in a (mostly) even distribution of execution                                                               |\n| No-Wait               | no-wait                 | Cycles through all action/task hooks in the Execute stage with no memory usage or other waits. __WARNING__: This persona may cause OOM.                                         |    \n| Ramped                | ramped                  | Starts at a batch size of  `batch_gradient` * `batch_size`. Batch size increases by the gradient each batch with an optional wait between each batch spawning                   |\n| Ramped Interval       | ramped-interval         | Executes `batch_size` hooks before waiting `batch_gradient` * `batch_interval` time. Interval increases by the gradient each batch                                              |\n| Sorted                | sorted                  | Executes each action/task hook in batches of the specified size and in the order provided to each hook's (optional) `order` parameter                                           |\n| Weighted              | weighted                | Executes action/task hooks in batches of the specified size, with each batch being generated from a sampled distribution based upon that action's weight                        |\n\n<br/>\n\n### __Algorithms__\n\nAlgorithms are used by Hyperscale `Optimize` stages to calculate maximal test config options like `batch_size`, `batch_gradient`, and/or `batch_interval`. All out-of-box supported algorithms use `scikit-learn` and include:\n\n| Algorithm                   | Setup Config Name    | Description                                                                                                                          |\n| ----------                  | ----------------     | -----------------                                                                                                                    |\n| SHG                         | shg                  | Uses `scikit-learn`'s Simple Global Homology (SHGO) global optimization algorithm                                                    |\n| Dual Annealing              | dual-annealing       | Uses `scikit-learn`'s Dual Annealing global optimization algorithm                                                                   |\n| Differential Evolution      | diff-evolution       | Uses `scikit-learn`'s Differential Evolution global optimization algorithm                                                           |\n| Point Optimizer (unstable)  | point-optimizer      | Uses a custom least-squares algorithm. Can only be used by assigning a distribution to a Variant stage for an Experiment.           |\n\n<br/>\n\n### __Reporters__\n\nReporters are the integrations Hyperscale uses for submitting aggregated and unaggregated results (for example, to a MySQL database via the MySQL reporter). Hyperscale currently supports the following Reporters, with additional install requirements shown if necessary:\n\n| Engine               | Additional Install Option                                 |  Dependencies                            |\n| -----------          | -----------                                               |------------                              |\n| AWS Lambda           | pip install hyperscale[aws]                               | boto3                                    |\n| AWS Timestream       | pip install hyperscale[aws]                               | boto3                                    |\n| Big Query            | pip install hyperscale[google]                            | google-cloud-bigquery                    |\n| Big Table            | pip install hyperscale[google]                            | google-cloud-bigtable                    |\n| Cassandra            | pip install hyperscale[cassandra]                         | cassandra-driver                         |\n| Cloudwatch           | pip install hyperscale[aws]                               | boto3                                    |\n| CosmosDB             | pip install hyperscale[azure]                             | azure-cosmos                             |\n| CSV                  | N/A                                                       | N/A                                      |\n| Datadog              | pip install hyperscale[datadog]                           | datadog                                  |\n| DogStatsD            | pip install hyperscale[statsd]                            | aio_statsd                               |\n| Google Cloud Storage | pip install hyperscale[google]                            | google-cloud-storage                     |\n| Graphite             | pip install hyperscale[statsd]                            | aio_statsd                               |\n| Honeycomb            | pip install hyperscale[honeycomb]                         | libhoney                                 |\n| InfluxDB             | pip install hyperscale[influxdb]                          | influxdb_client                          |\n| JSON                 | N/A                                                       | N/A                                      |\n| Kafka                | pip install hyperscale[kafka]                             | aiokafka                                 |\n| MongoDB              | pip install hyperscale[mongodb]                           | motor                                    |\n| MySQL                | pip install hyperscale[sql]                               | aiomysql, sqlalchemy                     |\n| NetData              | pip install hyperscale[statsd]                            | aio_statsd                               |\n| New Relic            | pip install hyperscale[newrelic]                          | newrelic                                 |\n| Postgresql           | pip install hyperscale[sql]                               | aiopg, psycopg2-binary, sqlalchemy       |\n| Prometheus           | pip install hyperscale[prometheus]                        | prometheus-client, prometheus-client-api |\n| Redis                | pip install hyperscale[redis]                             | redis, aioredis                          |\n| S3                   | pip install hyperscale[aws]                               | boto3                                    |\n| Snowflake            | pip install hyperscale[snowflake]                         | snowflake-connector-python, sqlalchemy   |\n| SQLite3              | pip install hyperscale[sql]                               | sqlalchemy                               |\n| StatsD               | pip install hyperscale[statsd]                            | aio_statsd                               |\n| Telegraf             | pip install hyperscale[statsd]                            | aio_statsd                               |\n| TelegrafStatsD       | pip install hyperscale[statsd]                            | aio_statsd                               |\n| TimescaleDB          | pip install hyperscale[sql]                               | aiopg, psycopg2-binary, sqlalchemy       |\n| XML                  | pip install hyperscale[xml]                               | dicttoxml                                |\n\n<br/>\n\n___________\n\n## <b>Resources</b>\n\nHyperscale's official and full documentation is currently being written and will be linked here soon!\n\n___________\n\n## <b>License</b>\n\nThis software is licensed under the MIT License. See the LICENSE file in the top distribution directory for the full license text.\n\n___________\n\n## <b>Contributing</b>\n\nHyperscale will be open to general contributions starting Fall, 2023 (once the distributed rewrite and general testing is complete). Until then, feel\nfree to use Hyperscale on your local machine and report any bugs or issues you find!\n\n___________\n\n## <b>Code of Conduct</b>\n\nHyperscale has adopted and follows the [Contributor Covenant code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md).\nIf you observe behavior that violates those rules please report to:\n\n| Name            | Email                       | Twitter                                      |\n|-------          |--------                     |----------                                    |\n| Sean Corbett    | sean.corbett@umontana.edu   | [@sc_codeum](https://twitter.com/sc_codeUM/) |\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Performance testing at scale.",
    "version": "0.1.5",
    "project_urls": {
        "Homepage": "https://github.com/hyper-light/hyperscale"
    },
    "split_keywords": [
        "pypi",
        " cicd",
        " python",
        " performance",
        " testing",
        " dag",
        " graph",
        " workflow"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ae4331163b3e28f9ede3d4fbf39d8d10ff71d04b166aa375db99efb122de7ab",
                "md5": "fccad92d79afc642d17255dbfbcd2e7e",
                "sha256": "836b137e9d70f220d55288c25e5c30097f493bacbe759c14da6fda6fd32a0643"
            },
            "downloads": -1,
            "filename": "hyperscale-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fccad92d79afc642d17255dbfbcd2e7e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1421757,
            "upload_time": "2024-06-20T02:36:03",
            "upload_time_iso_8601": "2024-06-20T02:36:03.881176Z",
            "url": "https://files.pythonhosted.org/packages/6a/e4/331163b3e28f9ede3d4fbf39d8d10ff71d04b166aa375db99efb122de7ab/hyperscale-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9592d8aca4c1785621fcc0208c33438b7373232b39ed8a311d1773e85b966a19",
                "md5": "63c2e51121e740397b73fc1ca06ce4ac",
                "sha256": "f33fbb44bf51d09e45be218017d25f885e4ef891b2c1affd2fff3c945c96248d"
            },
            "downloads": -1,
            "filename": "hyperscale-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "63c2e51121e740397b73fc1ca06ce4ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 813687,
            "upload_time": "2024-06-20T02:36:06",
            "upload_time_iso_8601": "2024-06-20T02:36:06.294684Z",
            "url": "https://files.pythonhosted.org/packages/95/92/d8aca4c1785621fcc0208c33438b7373232b39ed8a311d1773e85b966a19/hyperscale-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-20 02:36:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hyper-light",
    "github_project": "hyperscale",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hyperscale"
}
        
Elapsed time: 0.29738s