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 examples folder and routing from readme #514

Merged
merged 3 commits into from Jan 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 9 additions & 8 deletions CONTRIBUTING.rst
Expand Up @@ -13,23 +13,24 @@
~
-->

=======================
Contributing Guidelines
=======================

Pull Request Checklist
----------------------
======================

- Read the `contributing
guidelines <https://github.com/deepchecks/deepchecks/blob/master/CONTRIBUTING.md>`__.
guidelines <https://github.com/deepchecks/deepchecks/blob/master/CONTRIBUTING.rst>`__
- Check if your changes are consistent with the
`guidelines <https://github.com/deepchecks/deepchecks/blob/master/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution>`__.
`guidelines <#general-guidelines-for-contribution>`__
- Changes are consistent with the `coding
style <https://github.com/deepchecks/deepchecks/blob/master/CONTRIBUTING.md#coding-style>`__
style <#coding-style>`__
- Run the `unit
tests <https://github.com/deepchecks/deepchecks/blob/master/CONTRIBUTING.md#running-unit-tests>`__.
tests <#running-unit-tests>`__

General guidelines for contribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------

- Include unit tests when you contribute new features, as they help to
a) prove that your code works correctly, and b) guard against future
Expand All @@ -40,7 +41,7 @@ General guidelines for contribution
your pull request will comment on any API compatibility issues.

Coding Style
^^^^^^^^^^^^
------------

Changes to Python code should pass both linting and docstring check, to
make it easier with our contributors, we've included a ``makefile``
Expand All @@ -54,7 +55,7 @@ your code style, you can run
which in turn will run ``pylint`` and ``pydocstring`` on the code.

Running Unit Tests
^^^^^^^^^^^^^^^^^^
-------------------

Every Pull Request Submitted will be checked on every supported Python
version, in your on-going development, you can fall back to
Expand Down
4 changes: 4 additions & 0 deletions FAQ.rst
Expand Up @@ -12,3 +12,7 @@
~ ----------------------------------------------------------------------------
~
-->

===========================
Frequently Asked Questions
===========================
11 changes: 6 additions & 5 deletions deepchecks/suites/README.rst
Expand Up @@ -13,14 +13,15 @@
~
-->

======
Suites
======

Using an Existing Suite
-----------------------
=========================

`List of Prebuilt Suites <./default_suites.py>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List of Prebuilt Suites
---------------------------

- single_dataset_integrity - Runs a set of checks that are meant to
detect integrity issues within a single dataset.
Expand All @@ -35,7 +36,7 @@ Using an Existing Suite
checks.

Running a Suite
~~~~~~~~~~~~~~~
----------------

To run a prebuilt suite, first import it

Expand All @@ -50,7 +51,7 @@ Then run it with the required (suite-dependant) input parameters
model_evaluation().run(model=my_classification_model, train_dataset=ds_train, test_dataset=ds_test)

Creating Your Custom Suite
--------------------------
============================

Import Suite and Checks from deepchecks

Expand Down
Binary file added docs/images/notebook-example-launch-badges.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions examples/README.rst
@@ -0,0 +1,34 @@
========
Examples
========

Open from Docs - *Recommended*
==============================

All examples can be viewed in the
`Examples <https://docs.deepchecks.com/en/stable/examples/index.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=examples_folder>`__
section in the documentation.

Note that they can be also be launched directly from the documentation,
using google colab or binder,
by clicking on the badges that each notebook has on the top right side:

.. raw:: html

<p align="center">
<a href="https://docs.deepchecks.com/en/stable/examples/index.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=examples_folder_image">
<img src="/docs/images/notebook-example-launch-badges.png">
</a>
</p>

Download from Git
===================

Notice that viewing the notebooks within git **will not parse the graph outputs**.
Having said that, if you still want to access the raw examples notebooks directly, you can head to the
`examples folder <docs/source/examples>`__.

.. note::

In order to see the graphs when running a notebook locally, you need to `define it as **Trusted** <https://stackoverflow.com/questions/44943646/jupyter-notebook-not-trusted>`__