.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "checks_gallery/tabular/overview/plot_columns_info.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        Click :ref:`here <sphx_glr_download_checks_gallery_tabular_overview_plot_columns_info.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_checks_gallery_tabular_overview_plot_columns_info.py:


Columns Info
************
Imports
=======

.. GENERATED FROM PYTHON SOURCE LINES 10-17

.. code-block:: default


    import numpy as np
    import pandas as pd

    from deepchecks.tabular import Dataset
    from deepchecks.tabular.checks.overview import ColumnsInfo








.. GENERATED FROM PYTHON SOURCE LINES 18-20

Generating data
===============

.. GENERATED FROM PYTHON SOURCE LINES 20-31

.. code-block:: default


    num_fe = np.random.rand(500)
    cat_fe = np.random.randint(3, size=500)
    num_col = np.random.rand(500)
    date = range(1635693229, 1635693729)
    index = range(500)
    data = {'index': index, 'date': date, 'a': cat_fe, 'b': num_fe, 'c': num_col, 'label': cat_fe}
    df = pd.DataFrame.from_dict(data)

    dataset = Dataset(df, label='label', datetime_name='date', index_name='index', features=['a', 'b'], cat_features=['a'])








.. GENERATED FROM PYTHON SOURCE LINES 32-34

Running columns_info check
==========================

.. GENERATED FROM PYTHON SOURCE LINES 34-37

.. code-block:: default


    check = ColumnsInfo()








.. GENERATED FROM PYTHON SOURCE LINES 38-40

.. code-block:: default


    check.run(dataset=dataset)





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">

    <script
        src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"
        integrity="sha512-c3Nl8+7g4LMSTdrm621y7kf9v3SDPnhxLNhcjFJbKECVnmZHTdo+IRO05sNLTH/D3vA6u1X32ehoLC7WFVdheg=="
        crossorigin="anonymous"
        referrerpolicy="no-referrer">
    </script>

    <script type="text/javascript">window.PlotlyConfig = {MathJaxConfig: 'local'};</script>
    <script type="text/javascript">if (window.MathJax) {MathJax.Hub.Config({SVG: {font: "STIX-Web"}});}</script>
    <script type="text/javascript">
        if (typeof require !== 'undefined') {
            require.undef("plotly");
            requirejs.config({
                paths: {'plotly': ['https://cdn.plot.ly/plotly-2.8.3.min']}
            });
            require(
                ['plotly'],
                function(Plotly) {
                    window._Plotly = Plotly;
                    window.Plotly = Plotly;
                    console.log('Loaded plotly successfully');
                },
                function() {console.log('Failed to load plotly')}
            );
        } else {
            console.log('requirejs is not present');
        }
    </script>
    <h4><b>Columns Info</b></h4><p>Return the role and logical type of each column.</p><h5><b>Additional Outputs</b></h5><div>* showing only the top 10 columns, you can change it using n_top_columns param</div><style type="text/css">
    #T_d6fa1 table {
      text-align: left;
      white-space: pre-wrap;
    }
    #T_d6fa1 thead {
      text-align: left;
      white-space: pre-wrap;
    }
    #T_d6fa1 tbody {
      text-align: left;
      white-space: pre-wrap;
    }
    #T_d6fa1 th {
      text-align: left;
      white-space: pre-wrap;
    }
    #T_d6fa1 td {
      text-align: left;
      white-space: pre-wrap;
    }
    </style>
    <table id="T_d6fa1">
      <thead>
        <tr>
          <th class="blank level0" >&nbsp;</th>
          <th id="T_d6fa1_level0_col0" class="col_heading level0 col0" >index</th>
          <th id="T_d6fa1_level0_col1" class="col_heading level0 col1" >date</th>
          <th id="T_d6fa1_level0_col2" class="col_heading level0 col2" >label</th>
          <th id="T_d6fa1_level0_col3" class="col_heading level0 col3" >a</th>
          <th id="T_d6fa1_level0_col4" class="col_heading level0 col4" >b</th>
          <th id="T_d6fa1_level0_col5" class="col_heading level0 col5" >c</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th id="T_d6fa1_level0_row0" class="row_heading level0 row0" >role</th>
          <td id="T_d6fa1_row0_col0" class="data row0 col0" >index</td>
          <td id="T_d6fa1_row0_col1" class="data row0 col1" >date</td>
          <td id="T_d6fa1_row0_col2" class="data row0 col2" >label</td>
          <td id="T_d6fa1_row0_col3" class="data row0 col3" >categorical feature</td>
          <td id="T_d6fa1_row0_col4" class="data row0 col4" >numerical feature</td>
          <td id="T_d6fa1_row0_col5" class="data row0 col5" >other</td>
        </tr>
      </tbody>
    </table>

    </div>
    <br />
    <br />


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.009 seconds)


.. _sphx_glr_download_checks_gallery_tabular_overview_plot_columns_info.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download sphx-glr-download-python

     :download:`Download Python source code: plot_columns_info.py <plot_columns_info.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: plot_columns_info.ipynb <plot_columns_info.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_