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

Improve the documentation of API #2

Closed
6 tasks done
hbaniecki opened this issue Sep 10, 2022 · 0 comments · Fixed by #6
Closed
6 tasks done

Improve the documentation of API #2

hbaniecki opened this issue Sep 10, 2022 · 0 comments · Fixed by #6
Assignees
Labels
documentation 📚 Improvements or additions to documentation

Comments

@hbaniecki
Copy link
Member

hbaniecki commented Sep 10, 2022

A few things come to mind:

  • Description of explain()/explain_survival() does not say when to apply which function, while also all examples use explain()

image

  • Add informative descriptions to surv_fi and surv_integrated_fi, e.g. what the function does

image

  • Call x and explainer arguments "explainers"/"explainer objects" not "models"?

image
image

  • Add references (articles, URLs) to model_performance() and metrics/loss functions https://modeloriented.github.io/survex/reference/model_performance.surv_explainer.html

  • Add references (articles, URLs) to SurvLIME/SurvSHAP(t) methods

  • Let's add an information which functions return the objects named in descriptions of plotting functions, e.g. "the surv_shap object returned by the predict_parts(..., type="SurvSHAP(t)") function"

image

@hbaniecki hbaniecki added the documentation 📚 Improvements or additions to documentation label Sep 10, 2022
@mikolajsp mikolajsp self-assigned this Sep 26, 2022
@mikolajsp mikolajsp linked a pull request Sep 26, 2022 that will close this issue
krzyzinskim pushed a commit that referenced this issue Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📚 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants