Skip to main content

# Brute: easy grid search

## Introduction

This command-line script lets you run any command with many possible inputs in a distributed environment such as SGE, SLURM, or a local machine with many processors. Basic checkpointing is provided via the doit library, so that failed jobs might be re-run without re-running all jobs.

## Installation

Run:

python setup.py install

This should place the command brute in your path.

## Usage

Sample usage:

brute worker.py –foo 1,2,3 –bar x

will execute 3 tasks:

  • worker.py –foo 1 –bar x

  • worker.py –foo 2 –bar x

  • worker.py –foo 3 –bar x

Each task will have a subdirectory where a run script and a log file will be created. The location where the subdirectories are created may be controlled via the –brute-dir flag.

Grid-specific options go in a configuration file. See examples/brute.conf for an example.

## Summarizing results

In addition to the brute command-line script, the scrape command is provided to facilitate summarizing the results of large grid jobs. This command has two main uses:

  1. Obtain the job return status information. This is the default behavior, and produces a summary of the return status. Alternatively, –status-verbose prints the return status for all jobs instead of a summary.

  2. For jobs which produce a single number as a result, scrape may be used to sort and summarize the jobs according to this score.

This second use is especially useful in machine learning applications. For this purpose, a Python script must be provided via –scraper. This script must provide the following method:

def scrape(PATH):

# TODO: implement code to scrape job output return SCORE

The result will be the jobs and their arguments, sorted by their scores. The –max argument may be used to limit the number of displayed results.

Metadata

Release files for cmdline-brute 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cmdline-brute 0.3
File Size Uploaded Provenance Actions
cmdline-brute-0.3.tar.gz 6.6 kB Without provenance Details for cmdline-brute-0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cmdline-brute 0.3
File Interpreter ABI Platform Actions
cmdline_brute-0.3-py3.4.egg Legacy Egg format - - Details for cmdline_brute-0.3-py3.4.egg

Total release size: 24.4 kB

Release files / cmdline-brute-0.3.tar.gz

Download URL cmdline-brute-0.3.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
97939771fec05ab4c1ae95ca6fc882eb04597c75a278f12cb748b5158b6f4e3b
BLAKE2b-256 checksum
How to use checksums
b65a8e0bb68b5948de4ac56be297902e2498f9c6a9ea7bca8797f1c09ed8fed7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / cmdline_brute-0.3-py3.4.egg

Download URL cmdline_brute-0.3-py3.4.egg
Size 17.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
d8eb2c4e86c9fc1c1d23b378253a8243544fa44d3236cf970db0c42edc6bd1c1
BLAKE2b-256 checksum
How to use checksums
b71153c87872ebaeb4350018d7df610d7c0eafc1a9edb3923eb2af84252ee40f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for cmdline-brute 0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page