docs: document register_ci_test for custom CI tests - #273
Open
fesanghary wants to merge 1 commit into
Open
fesanghary wants to merge 1 commit into
fesanghary wants to merge 1 commit into
Conversation
register_ci_test/CIT_Base already support plugging in your own (or a third-party library's) conditional independence test, but it was undocumented outside a docstring. Adds a page to the independence-tests docs, plus a real-world example: the causal-ts library's GPU CI tests, which register through this exact mechanism. Includes measured kci vs kci_gpu numbers (NVIDIA L4) showing where the GPU tests pay off, and where they do not.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
register_ci_test/CIT_Basealready let you plug your own — or athird-party library's — conditional independence test into
CIT()and useit by name from
pc/fci/cdnod, but it's currently undocumented outsidea docstring in
cit.py. This adds a page to the independence-tests docs,plus a real-world example: the causal-ts
library's GPU-accelerated CI tests, which register through this exact
mechanism.
No code changes — this is docs-only (
register_ci_testalready ships andworks as-is).
What's included
docs/source/independence_tests_index/custom_ci_tests.rst(new)docs/source/independence_tests_index/index.rst— one-line toctree addition