Adapt for publication.

Quantco · Jun 9, 2024 · fcb2048 · fcb2048
1 parent 0b99eb1
commit fcb2048
Show file tree

Hide file tree

Showing 35 changed files with 84 additions and 87 deletions.
diff --git a/.github/assets/.condarc b/.github/assets/.condarc
@@ -1,8 +1,5 @@
 repodata_use_zst: true
 channels:
-  - qc-internal
   - conda-forge
-custom_channels:
-  qc-internal: https://conda.prod.quantco.cloud/t/${QUETZ_API_KEY}/get/
 conda_build:
   pkg_format: 2
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -8,9 +8,6 @@ defaults:
   run:
     shell: bash -el {0}
 
-env:
-  QUETZ_API_KEY: ${{ secrets.QUETZ_API_KEY }}
-
 jobs:
   run_benchmarks:
     name: Run benchmarks

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,9 +10,6 @@ defaults:
   run:
     shell: bash -el {0}
 
-env:
-  QUETZ_API_KEY: ${{ secrets.QUETZ_API_KEY }}
-
 jobs:
   pre-commit-checks:
     name: Pre-commit Checks
@@ -79,8 +76,3 @@ 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
-        uses: codecov/[email protected]
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: Quantco/metalearners
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -15,8 +15,4 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
           fetch-depth: 0
-      - name: Build conda package
-        uses: quantco/[email protected]
-        with:
-          quetz-api-key: ${{ secrets.QUETZ_API_KEY }}
-          upload-quetz: ${{ startsWith(github.ref, 'refs/tags/') }}
+      # TODO: Build and upload to PyPI.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,6 +5,8 @@ repos:
       - id: insert-license
         types: [python]
         args:
+          - --license-base64
+          - IyBDb3B5cmlnaHQgKGMpIFF1YW50Q28gMjAyNC0yMDI0CiMgU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEJTRC0zLUNsYXVzZQo=
           - --dynamic-years
           - --comment-style
           - "#"

diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# metalearners
+
+MetaLearners for CATE estimation
+
+## Installation
+
+You can install the package in development mode using:
+
+```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 .
+```
+
+## Credits
+
+Original implementation by @FrancescMartiEscofetQC and @kklein.
diff --git a/benchmarks/benchmark.py b/benchmarks/benchmark.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import json
 from pathlib import Path

diff --git a/conda.recipe/recipe.yaml b/conda.recipe/recipe.yaml
@@ -48,5 +48,7 @@ tests:
 
 about:
   homepage: https://github.com/quantco/metalearners
-  license: LicenseRef-QuantCo
+  license: BSD-3-Clause
+  license_family: BSD
+  license_file: LICENSE
   summary: "MetaLearners for CATE estimation"
diff --git a/data/download_twins.py b/data/download_twins.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import pandas as pd
 from git_root import git_root

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2022-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 # Configuration file for the Sphinx documentation builder.
 #

diff --git a/metalearners/__init__.py b/metalearners/__init__.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2022-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import importlib.metadata
 import warnings

diff --git a/metalearners/_typing.py b/metalearners/_typing.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from collections.abc import Collection
 from typing import Literal, Protocol, Union

diff --git a/metalearners/_utils.py b/metalearners/_utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import operator
 from collections.abc import Callable

diff --git a/metalearners/cross_fit_estimator.py b/metalearners/cross_fit_estimator.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import warnings
 from dataclasses import dataclass, field

diff --git a/metalearners/data_generation.py b/metalearners/data_generation.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from typing import Literal
 

diff --git a/metalearners/drlearner.py b/metalearners/drlearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 from typing_extensions import Self

diff --git a/metalearners/explainer.py b/metalearners/explainer.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from collections.abc import Collection
 

diff --git a/metalearners/metalearner.py b/metalearners/metalearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from abc import ABC, abstractmethod
 from collections.abc import Callable, Collection

diff --git a/metalearners/outcome_functions.py b/metalearners/outcome_functions.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from collections.abc import Callable
 

diff --git a/metalearners/rlearner.py b/metalearners/rlearner.py
@@ -1,6 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
-
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 from sklearn.metrics import log_loss, root_mean_squared_error

diff --git a/metalearners/slearner.py b/metalearners/slearner.py
@@ -1,6 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
-
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import warnings
 

diff --git a/metalearners/tlearner.py b/metalearners/tlearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 
 import numpy as np

diff --git a/metalearners/utils.py b/metalearners/utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 

diff --git a/metalearners/xlearner.py b/metalearners/xlearner.py
@@ -1,6 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
-
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 from typing_extensions import Self

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 
 import numpy as np

diff --git a/tests/test__utils.py b/tests/test__utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from contextlib import nullcontext as does_not_raise
 

diff --git a/tests/test_core.py b/tests/test_core.py
diff --git a/tests/test_cross_fit_estimator.py b/tests/test_cross_fit_estimator.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from functools import partial
 

diff --git a/tests/test_data_generation.py b/tests/test_data_generation.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from contextlib import nullcontext as does_not_raise
 

diff --git a/tests/test_learner.py b/tests/test_learner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 
 import numpy as np

diff --git a/tests/test_metalearner.py b/tests/test_metalearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 from itertools import chain
 

diff --git a/tests/test_outcome_functions.py b/tests/test_outcome_functions.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 import pytest

diff --git a/tests/test_rlearner.py b/tests/test_rlearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 import pandas as pd

diff --git a/tests/test_slearner.py b/tests/test_slearner.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 import pandas as pd

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# # Copyright (c) QuantCo 2024-2024
+# # SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 import pytest