replicate/cog-safe-push

replicate/cog-safe-push

Description: Safely push a Cog model version by making sure it works and is backwards-compatible with previous versions.

Language: Python

Stars: 16

Forks: 0

Open issues: 11

Created: 2024-08-21T17:59:44Z

Pushed: 2025-12-04T11:47:22Z

Default branch: main

Fork: no

Archived: no

README:

cog-safe-push

Safely push a Cog model version by making sure it works and is backwards-compatible with previous versions.

> [!TIP] > Check out our guide to building a CI/CD pipeline for your model, which includes a step-by-step walkthrough of how to use this tool.

Prerequisites

1. Set the ANTHROPIC_API_KEY and REPLICATE_API_TOKEN environment variables. 1. Install Cog and cog login 1. If you're running this from a cloned source, pip install . in the cog-safe-push directory.

Installation

This package is not on PyPI yet, but you can install it directly from GitHub using pip:

pip install git+https://github.com/replicate/cog-safe-push.git

Usage

To safely push a model to Replicate, run this inside your Cog directory:

$ cog-safe-push --test-hardware= /

This will: 1. Lint the predict file with ruff 1. Create a private test model on Replicate, named /-test running ` 1. Push the local Cog model to the test model on Replicate 1. Lint the model schema (making sure all inputs have descriptions, etc.) 1. If there is an existing version on the upstream /` model, it will 1. Make sure that the schema in the test version is backwards compatible with the existing upstream version 1. Run predictions against both upstream and test versions and make sure the same inputs produce the same (or equivalent) outputs 1. Fuzz the test model for five minutes by throwing a bunch of different inputs at it and make sure it doesn't throw any errors

Both the creation of model inputs and comparison of model outputs is handled by Claude.

Example GitHub Actions workflow

Create a new workflow file in .github/workflows/cog-safe-push.yaml and add the following:

name: Cog Safe Push

on:
workflow_dispatch:
inputs:
model:
description: 'The name of the model to push in the format owner/model-name'
type: string

jobs:
cog-safe-push:
# Tip: Create custom runners in your GitHub organization for faster builds
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"

- name: Install Cog
run: |
sudo curl -o /usr/local/bin/cog -L https://github.com/replicate/cog/releases/latest/download/cog_`uname -s`_`uname -m`
sudo chmod +x /usr/local/bin/cog

- name: cog login
run: |
echo ${{ secrets.COG_TOKEN }} | cog login --token-stdin

- name: Install cog-safe-push
run: |
pip install git+https://github.com/replicate/cog-safe-push.git

- name: Push selected models
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
REPLICATE_API_TOKEN: ${{ secrets.REPLICATE_API_TOKEN }}
run: |
cog-safe-push ${{ inputs.model }}

After pushing this workflow to the main branch, you can run it manually from the Actions tab.

Full help text

# cog-safe-push --help

usage: cog-safe-push [-h] [--config CONFIG] [--help-config]
[--test-model TEST_MODEL] [--no-push]
[--test-hardware TEST_HARDWARE] [--no-compare-outputs]
[--predict-timeout PREDICT_TIMEOUT] [--fast-push]
[--test-case TEST_CASES]
[--fuzz-fixed-inputs FUZZ_FIXED_INPUTS]
[--fuzz-disabled-inputs FUZZ_DISABLED_INPUTS]
[--fuzz-iterations FUZZ_ITERATIONS]
[--fuzz-prompt FUZZ_PROMPT] [--parallel PARALLEL]
[--ignore-schema-compatibility] [-v]
[--push-official-model]
[model]

Safely push a Cog model, with tests

positional arguments:
model Model in the format /

options:
-h, --help show this help message and exit
--config CONFIG Path to the YAML config file. If --config is not
passed, ./cog-safe-push.yaml will be used, if it
exists. Any arguments you pass in will override fields
on the predict configuration stanza.
--help-config Print a default cog-safe-push.yaml config to stdout.
--test-model TEST_MODEL
Replicate model to test on, in the format
/. If omitted, -test will
be used. The test model is created automatically if it
doesn't exist already
--no-push Only test the model, don't push it to
--test-hardware TEST_HARDWARE
Hardware to run the test model on. Only used when
creating the test model, if it doesn't already exist.
--no-compare-outputs Don't make predictions to compare that prediction
outputs match the current version
--predict-timeout PREDICT_TIMEOUT
Timeout (in seconds) for predictions. Default: 300
--fast-push Use the --x-fast flag when doing cog push
--test-case TEST_CASES
Inputs and expected output that will be used for
testing, you can provide multiple --test-case options
for multiple test cases. The first test case will be
used when comparing outputs to the current version.
Each --test-case is semicolon-separated key-value
pairs in the format
'=;[]'.
can either be '==' or '~='. If you use '==' then the output of the model must match
exactly the string or url you specify. If you use
'~=' then the AI will verify your output
based on . If you omit , it
will just verify that the prediction doesn't throw an
error.
--fuzz-fixed-inputs FUZZ_FIXED_INPUTS
Inputs that should have fixed values during fuzzing.
All other non-disabled input values will be generated
by AI. If no test cases are specified, these will also
be used when comparing outputs to the current version.
Semicolon-separated key-value pairs in the format
'=;' (etc.)
--fuzz-disabled-inputs FUZZ_DISABLED_INPUTS
Don't pass values for these inputs during fuzzing.
Semicolon-separated keys in the format ';'
(etc.). If no test cases are specified, these will
also be disabled when comparing outputs to the current
version.
--fuzz-iterations FUZZ_ITERATIONS
Maximum number of iterations to run fuzzing.
--fuzz-prompt FUZZ_PROMPT
Additional prompting for the fuzz input generation
--parallel PARALLEL Number of parallel prediction threads.
--ignore-schema-compatibility
Ignore schema compatibility checks when pushing the
model
-v, --verbose Increase verbosity level (max 3)
--push-official-model
Push to the official model defined in the config

Using a configuration file

You can use a configuration file instead of passing all arguments on the command line. If you create a file called cog-safe-push.yaml in your Cog directory, it will be used. Any command line arguments you pass will override the…