Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/agnostiqhq/covalent-cloud-github-workflow

Template for integrating Covalent Cloud's high-performance computing capabilities into GitHub Workflows

https://github.com/agnostiqhq/covalent-cloud-github-workflow

Science Score: 13.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

automation ci-cd cicd covalent github-actions github-workflow gpu high-performance-computing hpc mlops python serverless

Keywords from Contributors

data-pipeline parallelization agents interpretability standardization animal hack autograder report
Last synced: 5 months ago · JSON representation

Repository

Template for integrating Covalent Cloud's high-performance computing capabilities into GitHub Workflows

Basic Info
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
automation ci-cd cicd covalent github-actions github-workflow gpu high-performance-computing hpc mlops python serverless
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme

README.md

Covalent Cloud GitHub Workflow Template 🚀

This repository provides a template for integrating high-performance functions on Covalent Cloud seamlessly into your GitHub Workflows. The workflow demonstrates how to dispatch compute-intensive tasks, track their status, and store results for further analysis.

If you wish to read more, please take a look at the companion blog post, which will provide a detailed walkthrough, example use cases, and further explanations ✨. To learn more about Covalent Cloud, visit covalent.xyz and the documentation at docs.covalent.xyz. To use this, you need a Covalent Cloud account, please sign up here.

Note: This is just a template to get you started. You can customize it to fit your specific needs.

Overview 📝

  1. Job Submission: The workflow dispatches a series of high-performance functions to Covalent Cloud. For demonstration, these functions simulate intensive computation with a sleep operation and randomly return "done" or "failed" as the outcome.
  2. Status Tracking: The run status for each dispatched job is maintained in the runid_status.csv file.
  3. Result Storage: Upon completion, results are collected and stored in the results.csv file.

Getting Started 👐

  1. Clone the Repository: Get your own copy of this repository.
  2. Install Dependencies: Install required packages (pip install -r .github/workflows/requirements.txt)
  3. Covalent Cloud API Key: Set your Covalent Cloud API key as a GitHub secret named CC_API_KEY.

Potential Enhancements ✈️

  • Customization 🛠️ : Adapt to your workflow - modify covalent_workflow.py to replace the placeholder functions with your own computationally intensive code.
  • Flexible Triggers: Explore different trigger mechanisms (pull requests, code changes, external webhooks) to automate your workflow.
  • Workflow Separation: Consider separate workflows for job submission and result monitoring, potentially with different schedules, for better modularity.
  • Database Integration: Replace the simple CSV-based status tracking with a database solution (e.g., SQLite, PostgreSQL) for scalability and advanced querying.
  • Result Retrieval: Use Covalent primitives (cc.get_result) in other scripts or workflows to retrieve results and status updates for tasks dispatched within this workflow.

Key Takeaway 🗝️

This template provides a solid foundation for streamlining the integration of high-performance computing tasks into your GitHub development processes. The focus is on flexibility – adapt it to fit your specific computational needs! 💪

Learn More 📚

Owner

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

Developing Software for Advanced Computing

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 36
  • Total Committers: 3
  • Avg Commits per committer: 12.0
  • Development Distribution Score (DDS): 0.167
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
santoshkumarradha s****h@a****i 30
github-actions 4****] 4
Santosh kumar 2****a 2
Committer Domains (Top 20 + Academic)
agnostiq.ai: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total 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
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
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/submit_and_update.yaml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v4 composite
  • actions/setup-python v2 composite
.github/workflows/requirements.txt pypi
  • covalent-cloud *