Cloud-agnostic machine type scoring engine for computational workloads
Project description
cloudfit-core
Cloud-agnostic machine type scoring engine for computational workloads.
cloudfit-core is the foundation of the cloudfit ecosystem: a pure Python library that, given a workload profile, scores and ranks available cloud instances across providers. No cloud credentials required. No API calls. Just a workload spec in, ranked recommendations out.
Try it without installing anything. One-click UI for the form-driven try · Swagger docs for the API · Landing page for the visual tour.
The problem
Teams hardcode instance types (c2-standard-60, c7i.16xlarge) in infrastructure-as-code and pipeline configs. When a provider deprecates them or ships a better generation, nothing updates: cost drifts and performance degrades silently.
The free, on-by-default right-sizing tools (GCP Recommender, AWS Compute Optimizer) read live telemetry from instances that are already running. They cannot size the workloads that need a decision before they run: batch jobs, ephemeral pipelines, and pre-launch services that have no telemetry yet. That gap is the niche cloudfit targets.
cloudfit-core takes a declared workload profile (vCPU, RAM, GPU) and returns ranked, explainable instance recommendations, with no running instance and no telemetry required.
Scope today: the scoring engine is provider-agnostic (it ranks whatever candidates you give it), but the only live provider catalog shipped is GCP, via
cloudfit-provider-gcp. AWS is planned, not yet released.
Installation
pip install cloudfit-core
Requires Python 3.9+.
Quick start
from cloudfit import WorkloadProfile, MachineType, rank
# Define your workload
profile = WorkloadProfile(
vcpu=60,
ram_gb=224,
workload="io-intensive",
archetype="io", # io | cpu | mem | gpu | burst
optimize_for="balanced", # cost | performance | availability | balanced
)
# Provide candidate instances (from a cloudfit-provider-* package or your own list)
candidates = [
MachineType(id="c2-standard-60", provider="gcp", vcpu=60, ram_gb=240, price_hr=3.13),
MachineType(id="c3d-standard-60-lssd", provider="gcp", vcpu=60, ram_gb=240, price_hr=3.39),
MachineType(id="t2d-standard-60", provider="gcp", vcpu=60, ram_gb=240, price_hr=2.31),
MachineType(id="c7i.24xlarge", provider="aws", vcpu=96, ram_gb=192, price_hr=4.28),
]
# Score and rank
results = rank(profile, candidates)
for r in results:
print(f"{r.instance.id:30s} score={r.score:.2f} ${r.instance.price_hr:.2f}/hr")
Output:
t2d-standard-60 score=1.00 $2.31/hr
c2-standard-60 score=0.75 $3.13/hr
c3d-standard-60-lssd score=0.67 $3.39/hr
c7i.24xlarge score=0.00 $4.28/hr
c7i.24xlarge scores 0.00 and ranks last because its 192 GB RAM is below the
requested 224 GB: it's eliminated by the hard floor filter, not just ranked low
(see How scoring works).
Region-aware filtering (new in 0.2)
Set region on the workload profile to restrict candidates to a specific region. The hard floor disqualifies anything not available there, before scoring runs.
profile = WorkloadProfile(
vcpu=16,
ram_gb=64,
region="asia-southeast1", # only instances tagged with this region pass the floor
optimize_for="cost",
)
This pairs naturally with multi-region provider snapshots: cloudfit-provider-gcp.fetch_instances_all_regions(...) emits one MachineType entry per region the family is available in, and the region hard floor selects the right subset at scoring time. Useful when a pipeline runs in a specific region and you only want candidates that can actually launch there.
How scoring works
Every recommendation runs through the same weighted scoring function:
score = w_cost × cost_score + w_perf × perf_score + w_avail × avail_score
The optimize_for mode sets the weights:
| Mode | w_cost | w_perf | w_avail | Best for |
|---|---|---|---|---|
cost |
0.70 | 0.20 | 0.10 | Batch jobs, dev environments |
balanced |
0.33 | 0.34 | 0.33 | Default: production workloads |
performance |
0.10 | 0.80 | 0.10 | Latency-sensitive, GPU inference |
availability |
0.10 | 0.20 | 0.70 | Long-running jobs, deprecation risk |
Hard floor filters run before scoring: instances that don't meet minimum RAM, vCPU, or GPU requirements are eliminated entirely, not just ranked low.
Cost is normalized across the candidates, not against a fixed scale: the cheapest qualifying instance scores 1.0 on cost and the most expensive scores 0.0, so a real price gap produces a real score gap. An instance with no price (price_hr <= 0, e.g. a pricing lookup that failed) scores 0.0 on cost; a missing price is never treated as free.
Advanced users can override weights directly:
profile = WorkloadProfile(
vcpu=60,
ram_gb=224,
# Both short and long key spellings are accepted:
# short: {"cost": 0.5, "perf": 0.4, "avail": 0.1}
# long: {"cost": 0.5, "performance": 0.4, "availability": 0.1}
weights={"cost": 0.5, "performance": 0.4, "availability": 0.1}
)
Headroom (new in 0.5)
headroom asks for spare capacity above your declared vcpu and ram_gb, as a fraction. It is the compute sibling of the disk safety_margin. The default is 0.0 (no headroom), so existing behavior is unchanged.
profile = WorkloadProfile(
vcpu=60,
ram_gb=224,
headroom=0.15, # aim for 15% spare capacity
headroom_mode="hard", # "hard" (default) or "soft"
)
Two modes control how strictly the buffer is applied. With headroom=h, the target is declared × (1 + h).
| Mode | Hard floor | Perf scoring | Use when |
|---|---|---|---|
hard (default) |
Raised to the target: instances without the buffer are disqualified | Peak fit recenters on the target | You need the slack guaranteed |
soft |
Unchanged: nothing is disqualified | Peak fit recenters on the target, so instances below it lose fit credit but can still rank on cost or availability | You prefer the buffer but will accept a tight fit |
When both headroom and ram_floor_gb are set, the RAM floor is the larger of the two (max(ram_floor_gb, ram_gb × (1 + headroom))).
Workload archetypes
What
archetypedoes today: it is a classification label used for disk sizing and downstream tooling. It does not change ranking. Scoring is driven entirely byoptimize_forand the hard floors. Archetype-aware scoring (and fleet-vs-single-instance recommendations forburst) is on the roadmap and gated on validation data, so it is not wired into the scorer yet. Settingarchetype="mem"will not, on its own, bias the ranking toward high-memory families in this release.
cloudfit-core recognizes five resource archetypes. The "dominant constraint" column below describes the workload, not a scoring rule the engine applies:
| Archetype | Dominant constraint | Typical workloads |
|---|---|---|
io |
Disk throughput | Sequencing demultiplexing, short-read alignment |
cpu |
Thread parallelism | Variant calling, de novo assembly, quantification |
mem |
RAM capacity | Metagenomics classification, single-cell RNA-seq, Hi-C |
gpu |
GPU VRAM | Protein structure prediction, GPU variant calling, basecalling |
burst |
Fleet of small instances | Nextflow pipelines, Snakemake DAGs, WDL scatter-gather |
Dynamic disk sizing
For sequencing workloads, disk requirements scale with experiment parameters rather than being fixed. cloudfit-core estimates disk from experiment parameters:
These are planning estimates, not measurements. The per-lane sizes and the output/tmp/compression multipliers in
disk.pyare approximate heuristics, not validated against a corpus of real runs. Treat the result as a starting point for provisioning (the default 20% safety margin exists for this reason), and verify against your own pipeline before relying on it.
from cloudfit import compute_disk_tb, WorkloadProfile, DiskSpec
disk_tb = compute_disk_tb(
sequencer="novaseq_6000",
flowcell="s4",
lanes=4,
retain_input=False, # if True, raw input files are kept post-run
keep_undetermined=False, # if True, unmatched reads written to disk (+8%)
safety_margin=0.20,
)
# → 15.84 TB
# Use the result when building your workload profile
profile = WorkloadProfile(
vcpu=60,
ram_gb=224,
workload="io-intensive",
archetype="io",
disk=DiskSpec(sizing="static", scratch_tb=disk_tb),
)
compute_disk_tb is a standalone helper: call it before constructing your WorkloadProfile and pass the result into DiskSpec.scratch_tb.
Workload YAML schema
workload:
type: io-intensive
archetype: io
parallelism: lane # lane | sample | interval | process | rule
resources:
vcpu: 60
ram_gb: 224
disk:
sizing: dynamic # "dynamic" computes from experiment params; "static" uses scratch_tb
preferred: local_ssd_first
gpu:
required: false
scheduling:
spot: false
restart_tolerant: false
optimize_for: balanced # cost | performance | availability | balanced
providers:
- gcp
- aws
Load from file:
from cloudfit import from_yaml
profile = from_yaml("my-workload.yaml")
results = rank(profile, candidates)
Provider plugins
cloudfit-core is the scoring engine only: it scores whatever instances you give it. Provider plugins fetch live instance data from cloud APIs on a schedule and feed the registry:
pip install cloudfit-provider-gcp # fetches GCP Compute Engine machine types
pip install cloudfit-provider-aws # fetches AWS EC2 instance specs and pricing
Each provider implements a simple interface:
from cloudfit.providers.base import Provider
class MyProvider(Provider):
def fetch_instances(self, region: str) -> list[MachineType]: ...
def get_pricing(self, instance_id: str, region: str) -> float: ...
def get_availability(self, instance_id: str, region: str) -> float: ...
Want to add a provider? See CONTRIBUTING.md.
Terraform / OpenTofu integration
Once cloudfit-api is running, use the Terraform provider to resolve instance types at plan time:
data "cloudfit_recommendation" "demux_worker" {
vcpu = 60
ram_gb = 224
workload = "sequencing-demux"
optimize_for = "balanced"
}
resource "google_compute_instance" "worker" {
machine_type = data.cloudfit_recommendation.demux_worker.machine_type
}
Known limitations
cloudfit-core is at v0.3.0 and ships with documented gaps. Listed here in priority order, with planned mitigations. The math is open and auditable; these are not surprises, they are the next-release backlog.
| Limitation | Impact | Planned mitigation |
|---|---|---|
| GCP-only provider. No AWS, Azure, or other cloud catalogs yet. | Cannot rank AWS/Azure instances | cloudfit-provider-aws is the next planned provider (DescribeInstanceTypes + Pricing API) |
| No commitments awareness. CUDs, Savings Plans, and Reserved Instances are not factored. Recommendations are based on on-demand prices. | Inflated effective cost for customers with committed spend | Caller-provided commitments payload, computed effective_price_hr |
| No quota / capacity awareness. A recommendation may be technically valid but unlaunchable in a region with exhausted quota. | "Stuck in queue" failures | Optional quota_snapshot payload that hard-floors candidates exceeding remaining quota |
No GPU type discrimination. Only gpu_count and gpu_vram_gb are scored. A100 vs H100 vs L4 vs T4 look the same if VRAM matches. |
GPU recommendations may miss the right SKU for modern ML | GPU SKU as a scored dimension with TFLOPS and memory-bandwidth lookups |
| No CPU generation factor. A first-gen and third-gen instance with the same vCPU count score identically on perf. | Underweights modern instances that deliver more work per core | Add generation and architecture multipliers to the perf scorer |
Bundled snapshots are static. cloudfit-api ships with an 875-instance, five-region JSON refreshed manually via cloudfit-provider-gcp. |
Pricing drifts over time | Live registry refreshed hourly, versioned with provenance (fetched_at, source_etag) |
| No empirical validation. The scoring model is documented and auditable but has not been backtested against historical batch outcomes. | Recommendations are model predictions, not evidence-backed claims | Backtest harness ingesting Nextflow / Cromwell run history to compare cloudfit picks against actual run results |
A complete self-audit covering UX, operations, scoring methodology, and the v0.2 roadmap will be published alongside the next release. Issues and PRs that surface additional gaps are welcome: see CONTRIBUTING.md.
Citing cloudfit-core
If you use cloudfit-core in your research, please cite it:
@software{kasaraneni2026cloudfit,
author = {Kasaraneni, Chaitanya Krishna},
title = {cloudfit-core: Cloud-agnostic machine type scoring engine
for computational workloads},
year = {2026},
publisher = {GitHub},
url = {https://github.com/cloudfit-io/cloudfit-core},
orcid = {0000-0001-5792-1095}
}
GitHub also shows a Cite this repository button in the sidebar (powered by CITATION.cff).
Related publications
- Kasaraneni, C.K. et al. (2025). AI-Driven Drug Repurposing: A Graph Neural Network and Self-Supervised Learning Approach. IEEE CIACON. doi:10.1109/CIACON65473.2025.11189545
- Kasaraneni, C.K. et al. (2025). Multi-modality Medical Image Fusion Using Machine Learning/Deep Learning. Springer. doi:10.1007/978-3-031-98728-1_16
Related projects
In the cloudfit ecosystem:
cloudfit-provider-gcp: GCP Compute Engine machine-type fetcher (live PyPI)cloudfit-provider-aws: AWS EC2 fetcher (planning phase, accepting feedback)cloudfit-api: Stateless FastAPI service over cloudfit-core (live demo)cloudfit-ui: One-click Gradio demo over cloudfit-core (live demo)
Other open-source work:
samplesheet-parser: Format-agnostic Illumina SampleSheet parser (BCLConvert V2 + IEM V1)clinops: Clinical ML data quality library
Repository structure
cloudfit-core/
├── README.md # first thing every visitor reads
├── CITATION.cff # GitHub "Cite this repository" button: ORCID linked
├── pyproject.toml # packaging, dependencies, PyPI metadata
├── CONTRIBUTING.md # provider plugin interface guide
├── LICENSE # Apache 2.0
├── .gitignore
│
├── cloudfit/
│ ├── __init__.py # exports rank, recommend, key models
│ ├── models.py # WorkloadProfile, MachineType, ScoredInstance (pydantic v2)
│ ├── scorer.py # rank(), score_instance(), weight matrix
│ ├── filter.py # hard_floor_check(): RAM, vCPU, GPU hard filters
│ ├── disk.py # compute_disk_tb(): dynamic disk sizing formula
│ ├── yaml_loader.py # from_yaml(): loads workload YAML schema
│ └── providers/
│ ├── __init__.py
│ └── base.py # abstract Provider class: plugin contract
│
└── tests/
├── test_scorer.py # rank, scores, weight modes, hard floors
├── test_disk.py # disk formula, CBCL vs BCL factor, sequencer profiles
└── test_yaml.py # from_yaml() loads profiles correctly
Contributing
See CONTRIBUTING.md. Issues and pull requests are welcome: especially provider plugins for new cloud platforms (Azure, Hetzner, Oracle Cloud).
License
Apache 2.0: see LICENSE.
Author: Chaitanya Krishna Kasaraneni · Google Scholar · ORCID 0000-0001-5792-1095
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cloudfit_core-0.5.0.tar.gz.
File metadata
- Download URL: cloudfit_core-0.5.0.tar.gz
- Upload date:
- Size: 31.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c6a4f31a88f9b06a349b329a20553632967956a566f7bfd99a5633179f1f0897
|
|
| MD5 |
f4f391d3e51df89c8763c584513e3ff3
|
|
| BLAKE2b-256 |
ab60c73987de154e4c898479c247a0739cb542d8af56b3546fffec0ff9546c9d
|
Provenance
The following attestation bundles were made for cloudfit_core-0.5.0.tar.gz:
Publisher:
ci.yml on cloudfit-io/cloudfit-core
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cloudfit_core-0.5.0.tar.gz -
Subject digest:
c6a4f31a88f9b06a349b329a20553632967956a566f7bfd99a5633179f1f0897 - Sigstore transparency entry: 1742412468
- Sigstore integration time:
-
Permalink:
cloudfit-io/cloudfit-core@d9725c0c72e0ed898409b4a826df45ab97b33e72 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/cloudfit-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d9725c0c72e0ed898409b4a826df45ab97b33e72 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cloudfit_core-0.5.0-py3-none-any.whl.
File metadata
- Download URL: cloudfit_core-0.5.0-py3-none-any.whl
- Upload date:
- Size: 22.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a8b3f00436970ed062e900d160db00ec21dffc35c7af92aa73f7dbe33fc7561c
|
|
| MD5 |
017a84293f4807fe165aa72bbd9b575e
|
|
| BLAKE2b-256 |
3126ff13aea749ce87fc5b976c8458c232c6c1a87245e3e28d37a62e3744bc3d
|
Provenance
The following attestation bundles were made for cloudfit_core-0.5.0-py3-none-any.whl:
Publisher:
ci.yml on cloudfit-io/cloudfit-core
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cloudfit_core-0.5.0-py3-none-any.whl -
Subject digest:
a8b3f00436970ed062e900d160db00ec21dffc35c7af92aa73f7dbe33fc7561c - Sigstore transparency entry: 1742412633
- Sigstore integration time:
-
Permalink:
cloudfit-io/cloudfit-core@d9725c0c72e0ed898409b4a826df45ab97b33e72 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/cloudfit-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d9725c0c72e0ed898409b4a826df45ab97b33e72 -
Trigger Event:
push
-
Statement type: