From 2278f44fec607694df0e9136c54de53a3eda1143 Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 14:14:05 +0200 Subject: [PATCH 1/6] Add changelog entry. --- CHANGELOG.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 88aeeef..d56e1d9 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -10,6 +10,11 @@ Changelog 0.4.1 (2024-06-18) ------------------ +* Ship license file. + +0.4.1 (2024-06-18) +------------------ + * Fix dependencies for pip. 0.4.0 (2024-06-18) From 181705209fc726fd93b526a772d2ceb29307aa9f Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 16:37:01 +0200 Subject: [PATCH 2/6] Add codecov action to unit tests. --- .github/workflows/ci.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 58caef9..95173aa 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -76,3 +76,9 @@ jobs: with: report-title: Unit Tests - ${{ matrix.os == 'ubuntu-latest' && 'Linux' || 'Windows' }} - Python ${{ matrix.python-version }} custom-arguments: --cov=metalearners --cov-report=xml --cov-report term-missing --color=yes + - name: Upload coverage reports to Codecov + if: matrix.env == '3.12' + uses: codecov/codecov-action@125fc84a9a348dbcf27191600683ec096ec9021c + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + file: ./coverage.xml From d92a5929e92dc8943060fff39ea075f4b6188b47 Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 16:37:56 +0200 Subject: [PATCH 3/6] Update readme. --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6a37ca2..cfb344f 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ # metalearners +[![CI](https://github.com/Quantco/metalearners/actions/workflows/ci.yaml/badge.svg)](https://github.com/Quantco/metalearners/actions/workflows/ci.yaml) +[![Documentation Status](https://readthedocs.org/projects/metalearners/badge/?version=latest)](https://metalearners.readthedocs.io/en/latest/?badge=latest) +[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/metalearners?logoColor=white&logo=conda-forge)](https://anaconda.org/conda-forge/metalearners) +[![PypiVersion](https://img.shields.io/pypi/v/metalearners.svg?logo=pypi&logoColor=white)](https://pypi.org/project/metalearners) +[![codecov.io](https://codecov.io/github/QuantCo/metalearners/coverage.svg?branch=main)](https://codecov.io/github/QuantCo/metalearners?branch=main) + MetaLearners for CATE estimation ## Installation -You can install the package in development mode using: +`metalearners` can either be installed via PyPI with ```bash -git clone https://github.com/quantco/metalearners -cd metalearners - -# create and activate a fresh environment named metalearners -# see environment.yml for details -micromamba create -f environment.yml -micromamba activate metalearners - -pre-commit install -pip install --no-build-isolation -e . +$ pip install metalearners ``` -## Credits +or via conda-forge with -Original implementation by @FrancescMartiEscofetQC and @kklein. +```bash +$ conda install metalearners -c conda-forge +``` From 37070dd515e44acab6d99f666a43fa31db4d9e02 Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 16:38:37 +0200 Subject: [PATCH 4/6] Fix version number. --- CHANGELOG.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d56e1d9..259d800 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -7,7 +7,7 @@ Changelog ========= -0.4.1 (2024-06-18) +0.4.2 (2024-06-18) ------------------ * Ship license file. From af3a263003b7d73d88ce19d497e4e901550537b7 Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 16:43:00 +0200 Subject: [PATCH 5/6] Formatting. --- .github/workflows/ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 95173aa..6909f63 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,6 +24,7 @@ jobs: fetch-depth: 0 - name: Run pre-commit-conda uses: quantco/pre-commit-conda@v1 + mypy-type-checks: name: Mypy Type Checks runs-on: ubuntu-latest @@ -45,7 +46,7 @@ jobs: run: mypy . unit-tests: - name: Unit Tests - ${{ matrix.os == 'ubuntu-latest-8core' && 'Linux' || 'Windows' }} - Python ${{ matrix.python-version }} + name: Unit Tests - ${{ matrix.os == 'ubuntu-latest' && 'Linux' || 'Windows' }} - Python ${{ matrix.python-version }} timeout-minutes: 30 runs-on: ${{ matrix.os }} strategy: From 2b26d598ae08f68dd1146db795eb9ad9ca4518c0 Mon Sep 17 00:00:00 2001 From: kklein Date: Tue, 18 Jun 2024 16:56:39 +0200 Subject: [PATCH 6/6] Fix typo. --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6909f63..58768de 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -78,7 +78,7 @@ jobs: report-title: Unit Tests - ${{ matrix.os == 'ubuntu-latest' && 'Linux' || 'Windows' }} - Python ${{ matrix.python-version }} custom-arguments: --cov=metalearners --cov-report=xml --cov-report term-missing --color=yes - name: Upload coverage reports to Codecov - if: matrix.env == '3.12' + if: matrix.python-version == '3.12' uses: codecov/codecov-action@125fc84a9a348dbcf27191600683ec096ec9021c env: CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}