Skip to content

default branch was renamed from master to main #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Thanks for contributing to DoubleML.
Before submitting a PR, please take a look at our [contribution guidelines](https://github.com/DoubleML/doubleml-for-py/blob/master/CONTRIBUTING.md).
Before submitting a PR, please take a look at our [contribution guidelines](https://github.com/DoubleML/doubleml-for-py/blob/main/CONTRIBUTING.md).
Additionally, please fill out the PR checklist below.

### Description
Expand All @@ -14,7 +14,7 @@ Here you can add further comments.
You can also delete this section, if it is not necessary.

### PR Checklist
Please fill out this PR checklist (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-py/blob/master/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).
Please fill out this PR checklist (see our [contributing guidelines](https://github.com/DoubleML/doubleml-for-py/blob/main/CONTRIBUTING.md#checklist-for-pull-requests-pr) for details).

- [ ] The title of the pull request summarizes the changes made.
- [ ] The PR contains a detailed description of all changes and additions.
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ name: build
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- main
schedule:
- cron: "0 9 * * 1,3,5"
workflow_dispatch:
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# DoubleML - Contributing Guidelines <a href="https://docs.doubleml.org"><img src="https://raw.githubusercontent.com/DoubleML/doubleml-for-py/master/doc/logo.png" align="right" width = "120" /></a>
# DoubleML - Contributing Guidelines <a href="https://docs.doubleml.org"><img src="https://raw.githubusercontent.com/DoubleML/doubleml-for-py/main/doc/logo.png" align="right" width = "120" /></a>

DoubleML is a community effort.
Everyone is welcome to contribute.
All contributors should adhere to this contributing guidelines
and our [code of conduct](https://github.com/DoubleML/doubleml-for-py/blob/master/CODE_OF_CONDUCT.md).
and our [code of conduct](https://github.com/DoubleML/doubleml-for-py/blob/main/CODE_OF_CONDUCT.md).
The contributing guidelines are particularly helpful to get started for your first contribution.

## Submit a Bug Report :bug:
Expand Down Expand Up @@ -76,7 +76,7 @@ $ git remote add upstream https://github.com/DoubleML/doubleml-for-py.git
This allows you to easily keep your repository in synch via
```bash
$ git fetch upstream
$ git merge upstream/master
$ git merge upstream/main
```

5. Install the **development dependencies** via
Expand Down Expand Up @@ -112,7 +112,7 @@ When opening the PR you will be guided with a checklist.
- [x] **References** to related issues or PRs are added.

- [x] The code passes **all (unit) tests** (see
[below](https://github.com/DoubleML/doubleml-for-py/blob/master/CONTRIBUTING.md#unit-test-and-test-coverage)
[below](https://github.com/DoubleML/doubleml-for-py/blob/main/CONTRIBUTING.md#unit-test-and-test-coverage)
for details).
To check, please run
```bash
Expand All @@ -125,7 +125,7 @@ $ pytest .
- [x] Check whether your changes adhere to the **PEP8 standards**.
For the check you can use the following code
```bash
$ git diff upstream/master -u -- "*.py" | flake8 --diff --max-line-length=127
$ git diff upstream/main -u -- "*.py" | flake8 --diff --max-line-length=127
```

If your PR is still **work in progress**, please consider marking it a **draft PR**
Expand Down Expand Up @@ -160,7 +160,7 @@ new model class (e.g. regressions or classifications).
Furthermore, the **score components for the Neyman orthogonal score function need to be implemented**.
All other functionality is automatically available via inheritance from the abstract base class.
A **template for new model classes** is available
[here](https://github.com/DoubleML/doubleml-docs/blob/master/model_templates/double_ml_model_template.py).
[here](https://github.com/DoubleML/doubleml-docs/blob/main/model_templates/double_ml_model_template.py).

## Contribute Documentation :books:
The **documentation** of DoubleML is generated with **sphinx** and hosted at
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# DoubleML - Double Machine Learning in Python <a href="https://docs.doubleml.org"><img src="https://raw.githubusercontent.com/DoubleML/doubleml-for-py/master/doc/logo.png" align="right" width = "120" /></a>
# DoubleML - Double Machine Learning in Python <a href="https://docs.doubleml.org"><img src="https://raw.githubusercontent.com/DoubleML/doubleml-for-py/main/doc/logo.png" align="right" width = "120" /></a>

[![build](https://github.com/DoubleML/doubleml-for-py/workflows/build/badge.svg)](https://github.com/DoubleML/doubleml-for-py/actions?query=workflow%3Abuild)
[![PyPI version](https://badge.fury.io/py/DoubleML.svg)](https://badge.fury.io/py/DoubleML)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/doubleml.svg)](https://anaconda.org/conda-forge/doubleml)
[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-py/branch/master/graph/badge.svg?token=0BjlFPgdGk)](https://codecov.io/gh/DoubleML/doubleml-for-py)
[![codecov](https://codecov.io/gh/DoubleML/doubleml-for-py/branch/main/graph/badge.svg?token=0BjlFPgdGk)](https://codecov.io/gh/DoubleML/doubleml-for-py)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1c08ec7d782c451784293c996537de14)](https://www.codacy.com/gh/DoubleML/doubleml-for-py/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DoubleML/doubleml-for-py&amp;utm_campaign=Badge_Grade)
[![Python version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)](https://www.python.org/)

Expand Down Expand Up @@ -56,7 +56,7 @@ It further can be readily extended with regards to
- ... alternative resampling schemes,
- ...

![An overview of the OOP structure of the DoubleML package is given in the graphic available at https://github.com/DoubleML/doubleml-for-py/blob/master/doc/oop.svg](https://raw.githubusercontent.com/DoubleML/doubleml-for-py/master/doc/oop.svg)
![An overview of the OOP structure of the DoubleML package is given in the graphic available at https://github.com/DoubleML/doubleml-for-py/blob/main/doc/oop.svg](https://raw.githubusercontent.com/DoubleML/doubleml-for-py/main/doc/oop.svg)

## Installation

Expand Down Expand Up @@ -90,9 +90,9 @@ Detailed [installation instructions](https://docs.doubleml.org/stable/intro/inst
DoubleML is a community effort.
Everyone is welcome to contribute.
To get started for your first contribution we recommend reading our
[contributing guidelines](https://github.com/DoubleML/doubleml-for-py/blob/master/CONTRIBUTING.md)
[contributing guidelines](https://github.com/DoubleML/doubleml-for-py/blob/main/CONTRIBUTING.md)
and our
[code of conduct](https://github.com/DoubleML/doubleml-for-py/blob/master/CODE_OF_CONDUCT.md).
[code of conduct](https://github.com/DoubleML/doubleml-for-py/blob/main/CODE_OF_CONDUCT.md).

## Citation

Expand Down