Skip to content

Remove Bazel steps from Contributing Guide #2324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Remove Bazel steps from Contributing Guide #2324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,15 +112,6 @@ The first line relies on having an installation of [the GitHub CLI](https://gith
Following these commands you should be able to run the tests using `pytest keras_cv`.
Please report any issues running tests following these steps.

Note that this will _not_ install custom ops. If you'd like to install custom ops from source, you can compile the binaries and add them to your local environment manually (requires Bazel):

```shell
python build_deps/configure.py

bazel build keras_cv/custom_ops:all
mv bazel-bin/keras_cv/custom_ops/*.so keras_cv/custom_ops
```

## Run tests

KerasCV is tested using [PyTest](https://docs.pytest.org/en/6.2.x/).
Expand Down Expand Up @@ -148,18 +139,6 @@ You can run the unit tests for KerasCV by running:
pytest keras_cv/
```

### Tests that require custom ops

For tests that require custom ops, you'll have to compile the custom ops and make them available to your local Python code:

```shell
python build_deps/configure.py
bazel build keras_cv/custom_ops:all
cp bazel-bin/keras_cv/custom_ops/*.so keras_cv/custom_ops/
```

Tests which use custom ops are disabled by default, but can be run by setting the environment variable `TEST_CUSTOM_OPS=true`.

## Formatting the Code

We use `flake8`, `isort`, `black` and `clang-format` for code formatting. You can run
Expand Down