Skip to main content

NORM - coNstructiOn pRoject Manager

Norm is a CLI tool for benchmarking cost estimate generator models in construction projects. It evaluates model outputs against ground truths and provides a leaderboard for comparison. The name "Norm" was chosen because it sounds like a good PM name.

Report

Here's the full report which comprises the reasoning behind the product, methodology, results and future work.

Features

  • 📊 Benchmark Models: Compare model-generated cost estimates against ground truth data.
  • 📈 Leaderboard: Optionally upload benchmarking results to a leaderboard.
  • 🖥 Dashboard: Launch an interactive Streamlit dashboard to visualize results.

Installation

pip install norm-benchmark

Usage

Norm provides a simple CLI with two commands: benchmark and dashboard.

1. Run Benchmarking

Compare a model's output against ground truths:

norm benchmark <model_outputs.json> <ground_truths_directory> [--to_leaderboard]

Arguments:

  • <model_outputs.json>: Path to the JSON file containing model outputs.
  • <ground_truths_directory>: Path to the directory with ground truth data.
  • --to_leaderboard (optional): Uploads results to the leaderboard if specified.

2. Launch Dashboard

Start the Streamlit dashboard for visualizing benchmarking results:

norm dashboard

The dashboard will be available at: http://localhost:8501

Example

norm benchmark results.json ground_truths/ --to_leaderboard
norm dashboard

License

This project is licensed under the MIT License.

Metadata

Release files for norm-benchmark 0.14.1

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

Source distribution (sdist)

Source distribution for norm-benchmark 0.14.1
File Size Uploaded Provenance
norm_benchmark-0.14.1.tar.gz 8.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for norm-benchmark 0.14.1
File Interpreter ABI Platform
norm_benchmark-0.14.1-py3-none-any.whl Python 3 none any Details

Total release size: 18.6 kB

Release files / norm_benchmark-0.14.1.tar.gz

Download URL norm_benchmark-0.14.1.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
485da4d0514290b83dc23c989b26ef0ceff9bc87f1348135a0e3430f0a2d5b4e
BLAKE2b-256 checksum
How to use checksums
d165ea133cce3890f5f4b68f84ca7beb8bf0cacb351d5152cd620882af645d9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.4 Linux/6.8.0-52-generic

Release files / norm_benchmark-0.14.1-py3-none-any.whl

Download URL norm_benchmark-0.14.1-py3-none-any.whl
Size 10.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
82ed1b8be2691b46c90bb1b7fb7a2051b72494ba3e729380401a4927af659acf
BLAKE2b-256 checksum
How to use checksums
04ce37700d5743ee47f28802aa96e47f86fc39ad9b96ea9bce946e638cb8c115
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.4 Linux/6.8.0-52-generic

Security for norm-benchmark 0.14.1

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