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

Add flow diagram to README on selecting drift detectors #37

Open
tms-bananaquit opened this issue Jun 14, 2022 · 1 comment
Open

Add flow diagram to README on selecting drift detectors #37

tms-bananaquit opened this issue Jun 14, 2022 · 1 comment
Assignees

Comments

@tms-bananaquit
Copy link
Collaborator

We can have a "decision tree" on which setting each detector is appropriate for.

@tms-bananaquit
Copy link
Collaborator Author

Here's a draft of such a diagram, that excludes concerns like "how fast does it run" and "do you have >=10 features" that would make it an easier decision between e.g. HDDDM and kdq-tree, for example.

It should be as easy as switching this to the sphinx syntax for mermaid, putting that in an .rst file, and referencing that rst file in our index.rst.

graph TD
A[Do you have access to the model's predicted outcome?]
A -->|No| B
A -->|Yes| C
B[Do you have access to the data for each model feature?]
B -->|No| D
B -->|Yes| E
C[Can you easily/quickly obtain the true outcome?]
C -->|No| B
C -->|Yes| F
C -->|Eventually| G
D{{Access to either the data or the model output is required for drift detection.}}
E{{Data Drift Detector}}
F{{Concept Drift Detector}}
G{{Semi-supervised Detector}}
Loading

The sphinx-syntax is as above, but with semicolons terminating each line, and the ..mermaid:: directive, i.e..:

.. mermaid::

    graph TD;
        A[Do you have access to the model's predicted outcome?];
        A -->|No| B;
        A -->|Yes| C;
        B[Do you have access to the data for each model feature?];
        B -->|No| D;
        B -->|Yes| E;
        C[Can you easily/quickly obtain the true outcome?];
        C -->|No| B;
        C -->|Yes| F;
        C -->|Eventually| G;
        D{{Access to either the data or the model output is required for drift detection.}};
        E{{Data Drift Detector}};
        F{{Concept Drift Detector}};
        G{{Semi-supervised Detector}};

@tms-bananaquit tms-bananaquit removed this from In progress in GitHub Migration (v0.1.2) Jul 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants