Merge branch 'develop' of github.com:scienxlab/redflag into develop

scienxlab · Sep 27, 2023 · 71ba208 · 71ba208
2 parents d780177 + 003596a
commit 71ba208
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,7 +7,7 @@ name = "redflag"
 dynamic = ["version"]
 requires-python = ">=3.8"
 authors = [{ name="Matt Hall", email="[email protected]" },]
-description = "Raise red flags on machine learning datasets."
+description = "Safety net for machine learning pipelines."
 license = {file = "LICENSE"}
 readme = "README.md"
 keywords = ["machine learning", "data science", "quality assurance"]

diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,9 @@
+## Tests
+
+Note that most of the tests in `redflag` are doctests. The testing code is in the docstrings of the various functions, under the 'examples' heading.
+
+The Jupyter Notebooks in `docs/notebooks` are also run as part of the tests.
+
+To run the tests: clone the repo, install the dev dependencies (e.g. with `pip install .[dev]`) and do:
+
+    pytest