README: Notice of function removal

Chromite has removed functions used exclusively by this project.

BUG=chromium:905751
TEST=na

Change-Id: I0c10827fe81a4e9b0f0b46140b7f0cdb4de02dd8
Reviewed-on: https://chromium-review.googlesource.com/1361943
Commit-Ready: Dhanya Ganesh <dhanyaganesh@chromium.org>
Tested-by: Dhanya Ganesh <dhanyaganesh@chromium.org>
Reviewed-by: Jason Clinton <jclinton@chromium.org>
1 file changed
tree: 21801873f9d0d7d1f58d3bab7ae5c700674e370a
  1. bin/
  2. creds/
  3. lib/
  4. model/
  5. notebooks/
  6. .gitignore
  7. app.yaml
  8. appengine_config.py
  9. deploy_app.py
  10. gunicorn.conf.py
  11. main.py
  12. Pipfile
  13. Pipfile.lock
  14. PRESUBMIT.cfg
  15. pytest.ini
  16. README.md
README.md

Bad CL Detector [Discontinued]

https://chromium.googlesource.com/chromiumos/infra/bad_cl_detector

Deprecated [Dec 2018]

As of Dec 2018, the underlying database calls in this repository are no longer supported in Chromite.

Purpose:

A system to detect if a given build failure is caused by bad CL.

Getting started

The virtualenv for this project is managed with pipenv. If you don't already have pipenv installed, you can install it with “pip install pipenv”.

Then run:

deactivate  # make sure you are not already in a virtualenv
pipenv --two install
protoc -I=lib/protos --python_out=lib/protos

You can fetch cidb credentials with “cros cidbcreds”. You will need to pass in the db credentials' path to the script.

Training & cross validation

Downloading training data, training a model and cross validating is done by one script:

pipenv run python lib/bad_cl_detector_driver.py --cred-dir=$CRED_DIR

Or, you can enter a virtualenv shell with “pipenv shell”, and then just run python lib/.

Currently this requires word2vec and word2int files to work. Making this self-contained is a work in progress.

Tests

Tests are run with pytest:

pipenv run pytest