Skip to content
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

Rename internal indices to mask #91

Closed
kklein opened this issue Sep 3, 2024 · 0 comments · Fixed by #92
Closed

Rename internal indices to mask #91

kklein opened this issue Sep 3, 2024 · 0 comments · Fixed by #92
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@kklein
Copy link
Collaborator

kklein commented Sep 3, 2024

Various MetaLearners use indices to indicate which data point has seen which treatment variant in a field called _treatment_variant_indices, e.g.

self._treatment_variants_indices: list[np.ndarray] | None = None

self._treatment_variants_indices.append(w == treatment_variant)

This naming could suggest that this is a list of indices (e.g. integers) where a specific treatment has been seen. In reality, it is a list of as many booleans as observations. Therefore, calling it a 'mask' might be more appropriate and telling.

@kklein kklein added enhancement New feature or request good first issue Good for newcomers labels Sep 3, 2024
@kklein kklein linked a pull request Sep 4, 2024 that will close this issue
1 task
kklein pushed a commit that referenced this issue Sep 4, 2024
* rename indices to mask

* add CHANGELOG.rst entry

* rename additional variables in tlearner.py and update CHANGELOG.rst

* rename missed variables

* change indice to mask in drlearner.py and update CHANGELOG.rst

* remove changelog entry for 0.12.0 and files in docs/api
@kklein kklein closed this as completed in #92 Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant