.. _l-functions:

Functions
=========

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


Summary
+++++++

+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                             | class parent | truncated documentation                                                                                                                                                                                        |
+======================================================================================================================================+==============+================================================================================================================================================================================================================+
| :func:`AUC <ensae_projects.ml.competitions.AUC>`                                                                                     |              | Compute the `AUC <https://en.wikipedia.org/wiki/Area_under_the_curve_(pharmacokinetics)>`_.                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`AUC_multi <ensae_projects.ml.competitions.AUC_multi>`                                                                         |              | Compute the `AUC <https://en.wikipedia.org/wiki/Area_under_the_curve_(pharmacokinetics)>`_.                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`AUC_multi_multi <ensae_projects.ml.competitions.AUC_multi_multi>`                                                             |              | Compute the `AUC <https://en.wikipedia.org/wiki/Area_under_the_curve_(pharmacokinetics)>`_.                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_complete_subset_streets <ensae_projects.datainc.data_geo_streets._complete_subset_streets>`                                  |              | Extends a set of edges to have less extermities into the graph composed by the sets of edges.                                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_default_name <ensae_projects.hackathon.crypt_helper._default_name>`                                                          |              | Returns a default username.                                                                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_delete_edge <ensae_projects.challenge.city_tour._delete_edge>`                                                               |              | Removes an edge from the graph.                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_enumerate_close <ensae_projects.datainc.data_geo_streets._enumerate_close>`                                                  |              | Enumerates close streets from a starting point.                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_euler_path <ensae_projects.challenge.city_tour._euler_path>`                                                                 |              | Computes an Eulerian path.                                                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_explore_path <ensae_projects.challenge.city_tour._explore_path>`                                                             |              | Explores an Eulerian path, remove used edges from *edges_from*.                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_recurse_fill <ensae_projects.datainc.data_medical._recurse_fill>`                                                            |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_search_images_dogcat_keras <ensae_projects.restapi.search_images_dogcat._search_images_dogcat_keras>`                        |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_search_images_dogcat_torch <ensae_projects.restapi.search_images_dogcat._search_images_dogcat_torch>`                        |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <ensae_projects._setup_hook>`                                                                                     |              | does nothing                                                                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`add_missing_time <ensae_projects.datainc.data_bikes.add_missing_time>`                                                        |              | After aggregation, it usually happens that the series is sparse. This function adds rows for missing time.                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`added <ensae_projects.datainc.datazips.added>`                                                                                |              | Retrieves ``added.zip``.                                                                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`anyzip <ensae_projects.datainc.datazips.anyzip>`                                                                              |              | Any zip.                                                                                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`appariement <ensae_projects.challenge.velib_trajectories.appariement>`                                                        |              | On veut apparier les événemens -1 aux événemens +1. On s'attend aux colonnes suivantes: *"file"*, *"collect_date"*, ...                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`bellman_distances <ensae_projects.challenge.city_tour.bellman_distances>`                                                     |              | Computes shortest distances between all vertices. It assumes edges are symmetric.                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`besancon_df <ensae_projects.datainc.datazips.besancon_df>`                                                                    |              | Retrieves ``Besancon.df.zip``.                                                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`best_euler_path <ensae_projects.challenge.city_tour.best_euler_path>`                                                         |              | Computes the final solution for the Eulerian path.                                                                                                                                                             |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`build_streets_vertices <ensae_projects.datainc.data_geo_streets.build_streets_vertices>`                                      |              | Returns vertices and edges based on the subset of edges.                                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`cached_property <ensae_projects.challenge.blossom.cached_property>`                                                           |              | A memoize decorator for class properties.                                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`change_encoding <ensae_projects.datainc.data_helper.change_encoding>`                                                         |              | Changes the encoding of a text file and removes quotes. By default *process* is :func:`process_line`.                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`change_encoding_improve <ensae_projects.datainc.data_helper.change_encoding_improve>`                                         |              | Changes the encoding of a text file, removes quotes. By default *process* is :func:`process_line` but the function ...                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <ensae_projects.check>`                                                                                                 |              | Checks the library is working. It raises an exception.                                                                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`clean_column_name_sql_dump <ensae_projects.datainc.data_helper.clean_column_name_sql_dump>`                                   |              | Removes quotes in a line which looks like:                                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`clean_function_notebook <ensae_projects.automation.notebook_test_helper.clean_function_notebook>`                             |              | Cleans cells when unittesting notebooks.                                                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`compute_degrees <ensae_projects.challenge.city_tour.compute_degrees>`                                                         |              | Compute the degree of vertices.                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`connect_streets <ensae_projects.datainc.data_geo_streets.connect_streets>`                                                    |              | Tells if streets `st1`, `st2` are connected.                                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`convert_dates <ensae_projects.datainc.data_helper.convert_dates>`                                                             |              | Converts a string into a date.                                                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`convert_dcm2png <ensae_projects.datainc.data_medical.convert_dcm2png>`                                                        |              | Converts all medical images in a folder from format :epkg:`dcm` to :epkg:`png`.                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`cresus_dummy_file <ensae_projects.datainc.data_cresus.cresus_dummy_file>`                                                     |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`dcm2png <ensae_projects.cli.img_helper.dcm2png>`                                                                              |              | Converts all medical images in a folder from format :epkg:`dcm` to :epkg:`png`.                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`decrypt_dataframe <ensae_projects.datainc.croix_rouge.decrypt_dataframe>`                                                     |              | Reads an encrypted dataframe.                                                                                                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`df2rsthtml <ensae_projects.datainc.croix_rouge.df2rsthtml>`                                                                   |              | Writes a table into RST or HTML format.                                                                                                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`df_crossjoin <ensae_projects.datainc.data_bikes.df_crossjoin>`                                                                |              | Makes a cross join (cartesian product) between two dataframes by using a constant temporary key. Also sets a MultiIndex ...                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`dijkstra_path <ensae_projects.challenge.city_tour.dijkstra_path>`                                                             |              | Returns the best path between two vertices. Uses `Dikjstra <https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm>`_ ...                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`distance <ensae_projects.challenge.velib_trajectories.distance>`                                                              |              | Calcule une distance pour un appariement conçu ici comme la variance de la vitesse de chaque déplacement + la somme ...                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`distance_path <ensae_projects.challenge.velib_trajectories.distance_path>`                                                    |              | Calcule la vitesse moyenne lorsque le chemin est connu.                                                                                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`distance_solution <ensae_projects.challenge.city_tour.distance_solution>`                                                     |              | Checks if a solution is really a solution and returns the distance of it, None if it is not a solution. The function ...                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`distance_vertices <ensae_projects.challenge.city_tour.distance_vertices>`                                                     |              | Computes the length of edges if distances is None.                                                                                                                                                             |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`encrypt_file <ensae_projects.datainc.croix_rouge.encrypt_file>`                                                               |              | Encrypts a file with a specific password.                                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_batch_features <ensae_projects.hackathon.image_helper.enumerate_batch_features>`                                    |              | Enumerates all batches saved in a folder.                                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_events <ensae_projects.challenge.velib_trajectories.enumerate_events>`                                              |              | Construit la liste des événements (vélo réposé ou retiré).                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_image_class <ensae_projects.hackathon.image_helper.enumerate_image_class>`                                          |              | Lists all images in one folder assuming subfolders indicates the class of each image belongs to.                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_json_items <ensae_projects.hackathon.json_helper.enumerate_json_items>`                                             |              | Enumerates items from a JSON file or string.                                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_text_lines <ensae_projects.datainc.data_helper.enumerate_text_lines>`                                               |              | Enumerates all lines from a text file and does some cleaning (see the list of parameters).                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`euler_path <ensae_projects.challenge.city_tour.euler_path>`                                                                   |              | Computes an Eulerian path.                                                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`execute_notebooks <ensae_projects.automation.notebook_test_helper.execute_notebooks>`                                         |              | Executes a list of notebooks.                                                                                                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`extract_bing_result <ensae_projects.hackathon.web_search_helper.extract_bing_result>`                                         |              | Extract the first results from a search page assuming it comes from :epkg:`Bing Image`.                                                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`extract_images_from_json_2017 <ensae_projects.hackathon.json_helper.extract_images_from_json_2017>`                           |              | Extracts fields from a JSON files such as images.                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`folder_split_train_test <ensae_projects.hackathon.image_helper.folder_split_train_test>`                                      |              | Splits images from a folder into train and test. The function saves images into two separate folders.                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`folium_html_stations_map <ensae_projects.datainc.data_bikes.folium_html_stations_map>`                                        |              | Returns a :epkg:`folium` map which shows stations in different colors.                                                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`folium_html_street_map <ensae_projects.datainc.data_geo_streets.folium_html_street_map>`                                      |              | Returns a :epkg:`folium` map which represents the streets.                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_additional_paths <ensae_projects.automation.notebook_test_helper.get_additional_paths>`                                   |              | Returns a list of paths to add before running the notebooks, paths to :epkg:`pyquickhelper`, :epkg:`pyensae`.                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_chicago_stations <ensae_projects.datainc.data_bikes.get_chicago_stations>`                                                |              | Retrieves processed data from `Divvy Data <https://www.divvybikes.com/system-data>`_.                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_data <ensae_projects.challenge.velib_trajectories.get_data>`                                                              |              | Récupère les données.                                                                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_fields_description <ensae_projects.datainc.data_geo_streets.get_fields_description>`                                      |              | Retrieves a :epkg:`dataframe` which describes the meaning of the metadata.                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_max_delta <ensae_projects.challenge.blossom.get_max_delta>`                                                               |              | Returns the maximal value by which we can improve the dual solution by adjusting charges on alternating trees.                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_meaning <ensae_projects.datainc.croix_rouge.get_meaning>`                                                                 |              | Retrieves data related to the meaning of a table.                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_password <ensae_projects.automation.credentials_helper.get_password>`                                                     |              | Retrieves a password with `keyring <http://pythonhosted.org/keyring/>`_.                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_password <ensae_projects.hackathon.crypt_helper.get_password>`                                                            |              | Retrieves a password assocatied to *key*. Relies on module :epkg:`keyring`.                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_password_from_keyring_or_env <ensae_projects.datainc.croix_rouge.get_password_from_keyring_or_env>`                       |              | Gets the password from `keyring <https://pypi.python.org/pypi/keyring>`_ first, then from the environment variables. ...                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_seattle_streets <ensae_projects.datainc.data_geo_streets.get_seattle_streets>`                                            |              | Retrieves processed data from `Seattle Streets <https://data.seattle.gov/dataset/Street-Network-Database/ afip-2mzr/data)>`_. ...                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`haversine_distance <ensae_projects.challenge.city_tour.haversine_distance>`                                                   |              | Computes `Haversine formula <http://en.wikipedia.org/wiki/Haversine_formula>`_.                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`histogram_image_size <ensae_projects.hackathon.image_helper.histogram_image_size>`                                            |              | Computes the distribution of images size.                                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`image_zoom <ensae_projects.hackathon.image_helper.image_zoom>`                                                                |              | Resizes an *image* (from :epkg:`PIL`).                                                                                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`img2gray <ensae_projects.hackathon.image_helper.img2gray>`                                                                    |              | Converts an image (:epkg:`PIL`) to gray scale.                                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`last_element <ensae_projects.hackathon.image_helper.last_element>`                                                            |              | Returns the last element of sequence assuming they were generated by an iterator or a generator.                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_batch_features <ensae_projects.hackathon.image_helper.load_batch_features>`                                              |              | Loads a batch file saved by :func:`stream_image2features`.                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`ls_notebooks <ensae_projects.automation.notebook_test_helper.ls_notebooks>`                                                   |              | Lists the notebooks in a particular subfolder.                                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`main <ensae_projects.__main__.main>`                                                                                          |              | Implements ``python -m ensae_projects <command> <args>``.                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`main_codalab_wrapper_binary_classification <ensae_projects.ml.competitions.main_codalab_wrapper_binary_classification>`       |              | adapt the tempate available at `evaluate.py <https://github.com/Tivix/competition-examples/blob/master/hello_world/competition/scoring_program/evaluate.py>`_ ...                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`main_codalab_wrapper_multi_classification <ensae_projects.ml.competitions.main_codalab_wrapper_multi_classification>`         |              | adapt the tempate available at `evaluate.py <https://github.com/Tivix/competition-examples/blob/master/hello_world/competition/scoring_program/evaluate.py>`_ ...                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`matching_vertices <ensae_projects.challenge.city_tour.matching_vertices>`                                                     |              | Finds the best match between vertices.                                                                                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`merge_schema <ensae_projects.datainc.croix_rouge.merge_schema>`                                                               |              | Merges schemas of various databases.                                                                                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_gallery_random_images <ensae_projects.hackathon.image_helper.plot_gallery_random_images>`                                |              | Plots a gallery of images using :epkg:`matplotlib`. Extracts a random sample from a folder which contains many images. ...                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_streets_network <ensae_projects.datainc.data_geo_streets.plot_streets_network>`                                          |              | Plots the network based on :epkg:`cartopy`.                                                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_streets_network_projection <ensae_projects.datainc.data_geo_streets.plot_streets_network_projection>`                    |              | Returns the default projection for :func:`plot_streets_network`. See `projection <https://scitools.org.uk/cartopy/docs/v0.15/crs/projections.html>`_. ...                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`prepare_cresus_data <ensae_projects.datainc.data_cresus.prepare_cresus_data>`                                                 |              | Prepares the data for the challenge.                                                                                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`private_codalab_wrapper_binary_classification <ensae_projects.ml.competitions.private_codalab_wrapper_binary_classification>` |              | Wraps the function following the guidelines `User_Building a Scoring Program for a Competition <https://github.com/codalab/codalab-competitions/wiki/User_Building-a-Scoring-Program-for-a-Competition>`_. ... |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`private_codalab_wrapper_multi_classification <ensae_projects.ml.competitions.private_codalab_wrapper_multi_classification>`   |              | Wraps the function following the guidelines `User_Building a Scoring Program for a Competition <https://github.com/codalab/codalab-competitions/wiki/User_Building-a-Scoring-Program-for-a-Competition>`_. ... |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_cresus_sql <ensae_projects.datainc.data_cresus.process_cresus_sql>`                                                   |              | Processes the database sent by cresus and produces a list of flat files.                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`process_cresus_whole_process <ensae_projects.datainc.data_cresus.process_cresus_whole_process>`                               |              | Processes the database from :epkg:`Cresus` until it splits the data into two two sets of files.                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`query_bing_image <ensae_projects.hackathon.web_search_helper.query_bing_image>`                                               |              | Returns the search page from :epkg:`Bing Image` for a specific query.                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`random_answers_2020_images <ensae_projects.hackathon.random_answers.random_answers_2020_images>`                              |              | Generates random answers the deep learning challenge of hackathons :ref:`l-hackathon-2020`.                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`random_answers_2020_ml <ensae_projects.hackathon.random_answers.random_answers_2020_ml>`                                      |              | Generates random answers the machine learning challenge of hackathons :ref:`l-hackathon-2020`.                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`read_image <ensae_projects.hackathon.image_helper.read_image>`                                                                |              | Reads an image.                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`read_input <ensae_projects.challenge.blossom.read_input>`                                                                     |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`resize_image <ensae_projects.hackathon.image_helper.resize_image>`                                                            |              | Resizes an image until one of its dimension becomes smaller than *maxdim* after dividing the dimensions by two many ...                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`score_images <ensae_projects.hackathon.hack2020.score_images>`                                                                |              | Scores the predictions for images.                                                                                                                                                                             |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`search_images_dogcat <ensae_projects.restapi.search_images_dogcat.search_images_dogcat>`                                      |              | Defines a :epkg:`REST` application. It returns a list of neighbors among a small set of images representing dogs ...                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level>`                                |              | Returns a graph of streets.                                                                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level2 <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level2>`                              |              | Returns a small graph of streets.                                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level3 <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level3>`                              |              | Returns a small graph of streets.                                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_small <ensae_projects.datainc.data_geo_streets.seattle_streets_set_small>`                                |              | Returns a small graph of streets.                                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`set_password <ensae_projects.automation.credentials_helper.set_password>`                                                     |              | Stores a password with `keyring <http://pythonhosted.org/keyring/>`_.                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`set_password <ensae_projects.hackathon.crypt_helper.set_password>`                                                            |              | Stores a password assocatied to *key*. Relies on module :epkg:`keyring`.                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`shapely_records <ensae_projects.datainc.data_geo_streets.shapely_records>`                                                    |              | Uses `pyshp <https://pypi.python.org/pypi/pyshp/>`_ to return shapes and records from shapefiles.                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`split_XY_bind_dataset_cresus_data <ensae_projects.datainc.data_cresus.split_XY_bind_dataset_cresus_data>`                     |              | Splits XY for the blind set.                                                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`split_train_test_cresus_data <ensae_projects.datainc.data_cresus.split_train_test_cresus_data>`                               |              | Splits the tables into two sets for tables (based on users).                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`stream_apply_image_transform <ensae_projects.hackathon.image_helper.stream_apply_image_transform>`                            |              | Applies a transform on every image in a folder, saves it in another one. It keeps the same subfolders.                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`stream_copy_images <ensae_projects.hackathon.image_helper.stream_copy_images>`                                                |              | Copies all images from *src_folder* to *dest_folder* if *valid(name)* is True.                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`stream_download_images <ensae_projects.hackathon.image_helper.stream_download_images>`                                        |              | Downloads images based on their urls.                                                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`stream_image2features <ensae_projects.hackathon.image_helper.stream_image2features>`                                          |              | Considers all images in a folder, transform them into features (function *transform*) and saves them with :epkg:`pickle` ...                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`stream_random_sample <ensae_projects.hackathon.image_helper.stream_random_sample>`                                            |              | Extracts a random sample from a folder which contains many images. Relies on fonction :func:`enumerate_image_class`. ...                                                                                       |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`update_tree_structures <ensae_projects.challenge.blossom.update_tree_structures>`                                             |              |                                                                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`vitesse <ensae_projects.challenge.velib_trajectories.vitesse>`                                                                |              | Calcule la vitesse d'un déplacement.                                                                                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+