diff --git a/.github/workflows/cffconvert.yml b/.github/workflows/cffconvert.yml new file mode 100644 index 000000000..60fd8f62b --- /dev/null +++ b/.github/workflows/cffconvert.yml @@ -0,0 +1,22 @@ +name: cffconvert + +on: + push: + paths: + - CITATION.cff + pull_request: + paths: + - CITATION.cff + +jobs: + validate: + name: "validate" + runs-on: ubuntu-latest + steps: + - name: Check out a copy of the repository + uses: actions/checkout@v4 + + - name: Check whether the citation metadata from CITATION.cff is valid + uses: citation-file-format/cffconvert-github-action@2.0.0 + with: + args: "--validate" \ No newline at end of file diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..e3bf96722 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,31 @@ +# YAML 1.2 +--- +# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/) +cff-version: 1.2.0 +title: "Scikit-tree: Modern decision-trees compatible with scikit-learn in Python." +abstract: "scikit-tree is a scikit-learn compatible API for building state-of-the-art decision trees. These include unsupervised trees, oblique trees, uncertainty trees, quantile trees and causal trees." +authors: + - given-names: Adam + family-names: Li + affiliation: "Department of Computer Science, Columbia University, New York, NY, USA" + orcid: "https://orcid.org/0000-0001-8421-365X" + - given-names: Sambit + family-names: Panda + affiliation: "Department of Biomedical Engineering, Johns Hopkins University, Baltimore, MD, USA" + orcid: "https://orcid.org/0000-0001-8455-4243" + - given-names: Haoyin + family-names: Xu + affiliation: "Department of Biomedical Engineering, Johns Hopkins University, Baltimore, MD, USA" + orcid: "https://orcid.org/0000-0001-8235-4950" +type: software +repository-code: "https://github.com/neurodata/scikit-tree" +license: 'BSD-3-Clause' +keywords: + - random forest + - oblique trees + - honest forests + - statisical learning + - machine learning +message: >- + Please cite this software using the metadata from + 'preferred-citation' in the CITATION.cff file. diff --git a/README.md b/README.md index 12076150c..ac815d9ec 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![codecov](https://codecov.io/gh/neurodata/scikit-tree/branch/main/graph/badge.svg?token=H1reh7Qwf4)](https://codecov.io/gh/neurodata/scikit-tree) [![PyPI Download count](https://img.shields.io/pypi/dm/scikit-tree.svg)](https://pypistats.org/packages/scikit-tree) [![Latest PyPI release](https://img.shields.io/pypi/v/scikit-tree.svg)](https://pypi.org/project/scikit-tree/) +[![DOI](https://zenodo.org/badge/491260497.svg)](https://zenodo.org/doi/10.5281/zenodo.8412279) scikit-tree =========== diff --git a/sktree/_lib/sklearn_fork b/sktree/_lib/sklearn_fork index 6c7a5f44e..1adb20907 160000 --- a/sktree/_lib/sklearn_fork +++ b/sktree/_lib/sklearn_fork @@ -1 +1 @@ -Subproject commit 6c7a5f44eb4ec3bea5dd6a9e4d5db748d12b209e +Subproject commit 1adb209077f12adac8f760196ae5260abab0cbdd diff --git a/style_requirements.txt b/style_requirements.txt new file mode 100644 index 000000000..c3fb899a6 --- /dev/null +++ b/style_requirements.txt @@ -0,0 +1,9 @@ +mypy +black +isort +flake8 +bandit +pydocstyle +codespell +toml +cython-lint \ No newline at end of file