Welcome to the Giotto-tda use-cases challenge 2020. The purpose of this challenge is to create the best use-case of applied topology of the year! In order to participate to this challenge and have a chance to win, you have to submit a Jupyter Notebook to this repo (see the section below) with the following structure:
- Introduction, i.e. where the problem is explained
- Dataset, i.e. where the dataset is described
- Analysis, i.e. where the steps of the analysis are highlighted and the central role played by Giotto-tda is explained
- Short benchmark with comparable non-topological methods
Please have a look at the example_notebook.ipynb in the /example folder.
Anyone can take part to the challenge and participation is totally free: it is enough to send a PR (see the section below) and accept the CLA to be considered amongst the participants.
- There are no constraints on the data type to be used
- The dataset has to be public or publishable
- The code shall run compatibly with
- Giotto-tda has to play a central role in the analysis
- Performance: the Jupyter notebooks will be automatically tested when the PR is submitted. Their running time shall not exceed the 15 minutes on the GitHub Actions machines (some tolerance margin can be applied to this fifth rule)
- For a PR to be acceptable, all the automatic tests have to pass and the CLA has to be accepted by the submitter. An acceptable PR automatically subscribes the submitter to the challenge
- The first step is to fork this repository
- In the root folder of the cloned repository, in the master branch, create a new folder with your team leader's name (it is preferable if it coincides with the GitHub name of the team leader)
- Inside the folder created at step 2, place the unique Jupyter notebook with the usecase (the file shall end with
.ipynb
); the dataset and the auxilirary Python files (if needed) are also to be put in the same folder. Large datasets (i.e. with a size larger than 10MB) shall be directly imported from external URLs or from data sharing platforms such as OpenML. - If your project requires external
pip installable
libraries that are currently not amongst the requirements.txt, you can include them at the beginning of your Jupyter notebook by adding a few lines similar to the the following ones:
# Install a pip package in the current Jupyter kernel
import sys
!{sys.executable} -m pip install numpy scipy torch
The final PR submission date and hour will have to take place before the 30th of October 2020 at 23:59 CET.
Each participant, Giotto-tda maintainer and Giotto-tda collaborator as well as the L2F SA employees will vote (only once) on Google Form to express their preference for the three best notebooks. The three preferences must all three be different: e.g. one cannot select the same Jupyter notebook for both first and second place. Such irregular votes will be discarded. The link to the Google Form will be sent to those with voting rights soon after the 30th of October 2020.
On the 9th of November the evaluation phase will end and the first three winners will be announced. A Condorcet method will be used to preapre the final classification. The prizes will be the following:
- for the winner, 4000CHF
- for the second, 1000CHF
- for the third, 500CHF
The best three use-cases will be announced on the L2F SA social media and advertised through the web. The winner will also be contacted directly via email.
In case of irregularities, the sole and unique judge of this competition -- whose judgement is unquestionable -- will be L2F SA.
giotto-ai Slack workspace: https://slack.giotto.ai/