.. _l-properties:

Properties
==========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| property                                                                                                           | class parent               | truncated documentation                                                                                                     |
+====================================================================================================================+============================+=============================================================================================================================+
| :meth:`Groups <ensae_teaching_cs.automation_students.projects_repository.ProjectsRepository.Groups>`               | ProjectsRepository         | Returns all available groups in the repository.                                                                             |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Level <ensae_teaching_cs.special.elections.ElectionResults.Level>`                                          | ElectionResults            | Returns the level (``département`` or ``canton``).                                                                          |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`LevelCol <ensae_teaching_cs.special.elections.ElectionResults.LevelCol>`                                    | ElectionResults            | Returns the column associated to the level (their name depends on the level).                                               |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Location <ensae_teaching_cs.automation_students.projects_repository.ProjectsRepository.Location>`           | ProjectsRepository         |                                                                                                                             |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`T0 <ensae_teaching_cs.special.elections.ElectionResults.T0>`                                                | ElectionResults            | Returns the dataframe for the first round.                                                                                  |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`T1 <ensae_teaching_cs.special.elections.ElectionResults.T1>`                                                | ElectionResults            | Returns the dataframe for the second round.                                                                                 |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`WeightsNorm <ensae_teaching_cs.special.elections.ElectionResults.WeightsNorm>`                              | ElectionResults            | Returns the proportion of voters for each regions.                                                                          |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`Year <ensae_teaching_cs.special.elections.ElectionResults.Year>`                                            | ElectionResults            | Returns the year.                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <ensae_teaching_cs.ml.lasso_random_forest_regressor.LassoRandomForestRegressor._repr_html_>` | LassoRandomForestRegressor | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...            |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <ensae_teaching_cs.td_2a.custom_magics.CustomMagics.cross_validation_lock>`           | CustomMagics               | A contextmanager for running a block with our cross validation lock set to True. At the end of the block, ...               |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`daemon <ensae_teaching_cs.td_1a.flask_helper.FlaskInThread.daemon>`                                         | FlaskInThread              | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`daemon <ensae_teaching_cs.td_2a.parallel_thread.ParallelThread.daemon>`                                     | ParallelThread             | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`dataframe <ensae_teaching_cs.homeblog.table_formula.TableFormula.dataframe>`                                | TableFormula               | creates a pandas dataframe                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <ensae_teaching_cs.td_1a.flask_helper.FlaskInThread.ident>`                                           | FlaskInThread              | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <ensae_teaching_cs.td_2a.parallel_thread.ParallelThread.ident>`                                       | ParallelThread             | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`json <ensae_teaching_cs.homeblog.table_formula.TableFormula.json>`                                          | TableFormula               | returns a json format                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <ensae_teaching_cs.td_1a.flask_helper.FlaskInThread.name>`                                             | FlaskInThread              | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <ensae_teaching_cs.td_2a.parallel_thread.ParallelThread.name>`                                         | ParallelThread             | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <ensae_teaching_cs.td_1a.flask_helper.FlaskInThread.native_id>`                                   | FlaskInThread              | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <ensae_teaching_cs.td_2a.parallel_thread.ParallelThread.native_id>`                               | ParallelThread             | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`np_array <ensae_teaching_cs.homeblog.table_formula.TableFormula.np_array>`                                  | TableFormula               | returns the values as a numpy array                                                                                         |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`np_matrix <ensae_teaching_cs.homeblog.table_formula.TableFormula.np_matrix>`                                | TableFormula               | returns the values as a numpy matrix                                                                                        |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`shape <ensae_teaching_cs.homeblog.table_formula.TableFormula.shape>`                                        | TableFormula               | returns the size(nb rows, nb columns)                                                                                       |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`size <ensae_teaching_cs.homeblog.table_formula.TableFormula.size>`                                          | TableFormula               | returns the size(nb rows, nb columns)                                                                                       |
+--------------------------------------------------------------------------------------------------------------------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+