Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/agnostiqhq/covalent-ecs-plugin

Executor plugin interfacing Covalent with Amazon ECS Fargate

https://github.com/agnostiqhq/covalent-ecs-plugin

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary

Keywords

cloud-computing covalent docker elastic-container-registry elastic-container-service etl fargate parallelization pipelines python python3 quantum-computing workflow

Keywords from Contributors

quantum quantum-machine-learning data-pipeline hpc-applications machinelearning-python orchestration workflow-automation workflow-management gcp-batch batch
Last synced: 5 months ago · JSON representation

Repository

Executor plugin interfacing Covalent with Amazon ECS Fargate

Basic Info
  • Host: GitHub
  • Owner: AgnostiqHQ
  • License: apache-2.0
  • Language: Python
  • Default Branch: develop
  • Homepage: https://agnostiq.ai/covalent
  • Size: 470 KB
Statistics
  • Stars: 7
  • Watchers: 9
  • Forks: 1
  • Open Issues: 9
  • Releases: 32
Topics
cloud-computing covalent docker elastic-container-registry elastic-container-service etl fargate parallelization pipelines python python3 quantum-computing workflow
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

 

[![covalent](https://img.shields.io/badge/covalent-0.177.0-purple)](https://github.com/AgnostiqHQ/covalent) [![python](https://img.shields.io/pypi/pyversions/covalent-ecs-plugin)](https://github.com/AgnostiqHQ/covalent-ecs-plugin) [![tests](https://github.com/AgnostiqHQ/covalent-ecs-plugin/actions/workflows/tests.yml/badge.svg)](https://github.com/AgnostiqHQ/covalent-ecs-plugin/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/AgnostiqHQ/covalent-ecs-plugin/branch/main/graph/badge.svg?token=QNTR18SR5H)](https://codecov.io/gh/AgnostiqHQ/covalent-ecs-plugin) [![apache](https://img.shields.io/badge/License-Apache_License_2.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)

Covalent ECS Plugin

Covalent is a Pythonic workflow tool used to execute tasks on advanced computing hardware. This executor plugin interfaces Covalent with AWS Elastic Container Service (ECS) where the tasks are run using Fargate.

1. Installation

To use this plugin with Covalent, install it using pip:

sh pip install covalent-ecs-plugin

2. Usage Example

This is an example of how a workflow can be constructed to use the AWS ECS executor. In the example, we train a Support Vector Machine (SVM) and use an instance of the executor to execute the train_svm electron. Note that we also require DepsPip which will be required to execute the electrons.

```python from numpy.random import permutation from sklearn import svm, datasets import covalent as ct

deps_pip = ct.DepsPip( packages=["numpy==1.22.4", "scikit-learn==1.1.2"] )

executor = ct.executor.ECSExecutor( s3bucketname="covalent-fargate-task-resources", ecsclustername="covalent-fargate-cluster", ecstaskexecutionrolename="ecsTaskExecutionRole", ecstaskrolename="CovalentFargateTaskRole", ecstasksubnetid="subnet-871545e1", ecstasksecuritygroupid="sg-0043541a", ecstaskloggroupname="covalent-fargate-task-logs", vcpu=1, memory=2, poll_freq=10, )

Use executor plugin to train our SVM model

@ct.electron( executor=executor, depspip=depspip ) def train_svm(data, C, gamma): X, y = data clf = svm.SVC(C=C, gamma=gamma) clf.fit(X[90:], y[90:]) return clf

@ct.electron def loaddata(): iris = datasets.loadiris() perm = permutation(iris.target.size) iris.data = iris.data[perm] iris.target = iris.target[perm] return iris.data, iris.target

@ct.electron def scoresvm(data, clf): Xtest, ytest = data return clf.score( Xtest[:90],y_test[:90] )

@ct.lattice def runexperiment(C=1.0, gamma=0.7): data = loaddata() clf = trainsvm( data=data, C=C, gamma=gamma ) score = scoresvm( data=data, clf=clf ) return score

Dispatch the workflow.

dispatchid = ct.dispatch(runexperiment)( C=1.0, gamma=0.7 )

Wait for our result and get result value

result = ct.getresult(dispatchid, wait=True).result

print(result) ``` During the execution of the workflow, one can navigate to the UI to see the status of the workflow. Once completed, the above script should also output a value with the score of our model.

sh 0.8666666666666667

In order for the above workflow to run successfully, one has to provision the required cloud resources as mentioned in the section Required AWS Resources.

3. Configuration

There are many configuration options that can be passed into the ct.executor.ECSExecutor class or by modifying the covalent config file under the section [executors.ecs]

For more information about all of the possible configuration values, visit our read the docs (RTD) guide for this plugin.

4. Required AWS Resources

In order for workflows to leverage this executor, users must ensure that all the necessary IAM permissions are properly setup and configured. This executor uses the S3, ECR, and ECS services to execute an electron, thus the required IAM roles and policies must be configured correctly. Precisely, the following resources are needed for the executor to run any dispatched electrons properly.

| Resource | Config Name | Description | | ------------ | ---------------- | ----------- | | IAM Role | ecstaskexecutionrolename | The IAM role used by the ECS agent | | IAM Role | ecstaskrolename | The IAM role used by the container during runtime | | S3 Bucket | s3bucketname | The name of the S3 bucket where objects are stored | | ECR repository | ecrreponame | The name of the ECR repository where task images are stored | | ECS Cluster | ecsclustername | The name of the ECS cluster on which your tasks are executed | | VPC Subnet | ecstasksubnetid | The ID of the subnet where instances are created | | Security group | ecstasksecuritygroupid | The ID of the security group for task instances | | Cloudwatch log group | ecstaskloggroupname | The name of the CloudWatch log group where container logs are stored | | CPU | vCPU | The number of vCPUs available to a task | | Memory | memory | The memory (in GB) available to a task |

Getting Started with Covalent

For more information on how to get started with Covalent, check out the project homepage and the official documentation.

Release Notes

Release notes are available in the Changelog.

Citation

Please use the following citation in any publications:

W. J. Cunningham, S. K. Radha, F. Hasan, J. Kanem, S. W. Neagle, and S. Sanand. Covalent. Zenodo, 2022. https://doi.org/10.5281/zenodo.5903364

License

Covalent is licensed under the Apache License 2.0. See the LICENSE file or contact the support team for more details.

Owner

  • Name: Agnostiq
  • Login: AgnostiqHQ
  • Kind: organization
  • Email: contact@agnostiq.ai
  • Location: Toronto

Developing Software for Advanced Computing

GitHub Events

Total
  • Push event: 4
Last Year
  • Push event: 4

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 90
  • Total Committers: 9
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.622
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
CovalentOpsBot c****t 34
Alejandro Esquivel ae@a****d 16
Will Cunningham w****l@a****i 16
Faiyaz Hasan f****z@a****i 13
Venkat Bala 1****a 4
mpvgithub 1****b 3
Scott Wyman Neagle w****a@p****m 2
jkanem j****m@g****m 1
Okechukwu Emmanuel Ochia o****u@a****i 1
Committer Domains (Top 20 + Academic)
agnostiq.ai: 3 alejandro.ltd: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 21
  • Total pull requests: 50
  • Average time to close issues: 8 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 8
  • Total pull request authors: 10
  • Average comments per issue: 0.19
  • Average comments per pull request: 0.9
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • AlejandroEsquivel (7)
  • FyzHsn (4)
  • Emmanuel289 (2)
  • scottwn (2)
  • venkatBala (2)
  • cjao (1)
  • kessler-frost (1)
  • jkanem (1)
Pull Request Authors
  • AlejandroEsquivel (17)
  • FyzHsn (13)
  • wjcunningham7 (6)
  • mpvgithub (4)
  • venkatBala (4)
  • dependabot[bot] (2)
  • pre-commit-ci[bot] (2)
  • scottwn (2)
  • jkanem (1)
  • Emmanuel289 (1)
Top Labels
Issue Labels
east (3) Team West (2) refactor / small (1) Epic (1) testing (1) testing / validation (1) docs (1) infra (1) testing / integration tests (1) testing / unit tests (1)
Pull Request Labels
dependencies (2) Team West (1) improvements / style (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 71 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 36
  • Total maintainers: 1
pypi.org: covalent-ecs-plugin

Covalent ECS Plugin

  • Versions: 36
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 71 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 11.5%
Average: 20.5%
Stargazers count: 23.3%
Forks count: 30.5%
Dependent repos count: 30.6%
Maintainers (1)
wjcunningham7
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • boto3 ==1.20.48
  • covalent ==0.177.0rc0
  • docker ==5.0.3
tests/requirements.txt pypi
  • pytest ==6.2.5 test
  • pytest-mock ==3.6.1 test
.github/workflows/changelog.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v3 composite
.github/workflows/changelog_reminder.yml actions
  • actions/checkout master composite
  • peterjgrainger/action-changelog-reminder v1.3.0 composite
.github/workflows/license.yml actions
  • actions/checkout v3 composite
  • pilosus/action-pip-license-checker main composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • ncipollo/release-action v1 composite
.github/workflows/tests.yml actions
  • actions-ecosystem/action-get-latest-tag v1 composite
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v3 composite
.github/workflows/version.yml actions
  • AgnostiqHQ/covalent/.github/actions/version develop composite
  • actions/checkout v3 composite
tests/functional_tests/requirements.txt pypi
  • numpy ==1.23.2 test
  • python-dotenv ==0.21.0 test
  • scikit-learn ==1.1.2 test