Skip to main content

A CLI tool that runs GitHub projects on free cloud GPUs

Project description

RunOnGPU

RunOnGPU is a CLI tool that helps you run GitHub projects on a GPU with minimal setup.

It is useful if you want to test CUDA, PyTorch, or other GPU code but do not have a local NVIDIA GPU.

Requirements

  • Windows
  • Python 3.10+
  • Git
  • Google Chrome
  • Google account for Colab

Install

pip install runongpu
python -m playwright install

Check setup:

```bash
runongpu doctor

Quick Start

Go to the project you want to run and initialize RunOnGPU:

runongpu init

Enter your GitHub repo URL when asked.

This creates a runongpu.txt file. Edit this file to tell RunOnGPU how to set up, build, test, and run your project.

Then run:

runongpu run

RunOnGPU will open Colab, copy the starter notebook, clone your repo, set the runtime to a T4 GPU, and run your commands.

runongpu.txt

runongpu.txt controls what happens inside Colab.

It has four sections:

[setup]
# install dependencies here

[build]
# compile or build the project here

[test]
# run tests here

[run]
# run the final program here

Add one command per line.

Example: CUDA

If your repo has this structure:

my-cuda-project/
├── main.cu
└── runongpu.txt

Use:

[setup]

[build]
nvcc main.cu -o vector_add

[test]

[run]
./vector_add

Example: CUDA in a Subfolder

If your repo has this structure:

runongpu-examples/
├── cuda/
│   └── vector-add/
│       └── main.cu
└── runongpu.txt

Use:

[setup]

[build]
cd cuda/vector-add && nvcc main.cu -o vector_add

[test]

[run]
cd cuda/vector-add && ./vector_add

Example: Python

[setup]
pip install -r requirements.txt

[build]

[test]
pytest

[run]
python main.py

Example: CMake

[setup]

[build]
cmake -S . -B build
cmake --build build

[test]
ctest --test-dir build --output-on-failure

[run]
./build/my_program

Notes

On the first run, you may need to sign into Google Colab. RunOnGPU saves the copied notebook URL and reuses it on future runs.

Do not interact with the Colab window while RunOnGPU is setting it up.

Run Tests

python -m pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runongpu-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runongpu-0.1.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file runongpu-0.1.0.tar.gz.

File metadata

  • Download URL: runongpu-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for runongpu-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2fa96b3b7df346b5c07b20b7741593bf574f4541cb60943b39c2f392d241896f
MD5 4149186e8442fefc26c9b51c7aecb0b1
BLAKE2b-256 7cdcade2300dbb4e51af736f8ba33c8e1cc0cbe04e825e52c4a88146347d7382

See more details on using hashes here.

File details

Details for the file runongpu-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: runongpu-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for runongpu-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b9334c5976a5e93ed427632b77cf8c276dbe98c85e2bbca66c912fc6b221f9a
MD5 32a4c7926cf5e969d2ed0cf1dd7cf5be
BLAKE2b-256 b7c352b6c77f35845a4bb574494cdb9937fc84abb330c04076860edbf4e14195

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page