diff --git a/pyproject.toml b/pyproject.toml index 7a32658..c723446 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ name = "redflag" dynamic = ["version"] requires-python = ">=3.8" authors = [{ name="Matt Hall", email="kwinkunks@gmail.com" },] -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 new file mode 100644 index 0000000..bb3750d --- /dev/null +++ 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