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

DOC: update docs and tutorials to 2.0 #321

Merged
merged 121 commits into from
Sep 13, 2022

Conversation

mtsokol
Copy link
Contributor

@mtsokol mtsokol commented Jan 25, 2022

Hi @j-ittner!

In this PR I will submit all updated tutorials and docs, here's todo list:

  • Classification Tutorial: Prediabetes update
  • auxiliary Diabetes getting stared update
  • Introductory Tutorial: Incident risk of drilling operations update
  • Generating Standard Scikit-learn Classifier Performance Summaries update
  • sphinx documentation update

Sequential PR: Need to merge #317 first.

j-ittner and others added 27 commits March 8, 2022 15:45
# Conflicts:
#	.pre-commit-config.yaml
#	environment.yml
#	pyproject.toml
# Conflicts:
#	src/facet/validation/_validation.py
DOC: finalize API documentation for 2.0 release
* API: move simulation base classes to new module facet.simulation.base

* REFACTOR: remove an obsolete 'if' clause

* REFACTOR: declare constant for repetitive string literal

* FIX: change a type hint from List to Sequence

* DOC: remove an obsolete comment

* REFACTOR: declare constants for repetitive string literals

* REFACTOR: clarified comments and variable names

* REFACTOR: de-complexify Sample.__init__

* REFACTOR: remove an unused variable

* REFACTOR: disambiguate a regular expression

* REFACTOR: merge a nested 'if' expression

* REFACTOR: improve comments

* REFACTOR: simplify CSS

* REFACTOR: un-bracket alternatives in regular expression

* TEST: remove unused fixtures from test method arguments

* TEST: remove an obsolete to-do

* TEST: anonymize unused loop variables

* TEST: add constants for recurring exception messages

* TEST: minor code tweaks
# Conflicts:
#	src/facet/data/_sample.py
# Conflicts:
#	src/facet/data/_sample.py
#	src/facet/inspection/_explainer.py
#	src/facet/inspection/_shap_global_explanation.py
# Conflicts:
#	sphinx/source/contribution_guide.rst
Copy link
Member

@j-ittner j-ittner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@j-ittner j-ittner merged commit 7ad28b9 into 2.0.x Sep 13, 2022
@j-ittner j-ittner deleted the doc/update_docs_and_tutorials_to_2.0 branch September 13, 2022 09:55
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 this pull request may close these issues.

2 participants