DOI: 10.5281/zenodo.7868228
title: Replication Package: Unboxing Default Argument Breaking Changes in Scikit Learn

description: <strong>Replication Package</strong> This repository contains data and source files needed to replicate our work described in the paper "Unboxing Default Argument Breaking Changes in Scikit Learn". <strong>Requirements</strong> We recommend the following requirements to replicate our study: Internet access At least 100GB of space Docker installed Git installed <strong>Package Structure</strong> We relied on Docker containers to provide a working environment that is easier to replicate. Specifically, we configure the following containers: <code>data-analysis</code>, an R-based Container we used to run our data analysis. <code>data-collection</code>, a Python Container we used to collect Scikit's default arguments and detect them in client applications. <code>database</code>, a Postgres Container we used to store clients' data, obtainer from Grotov et al. <code>storage</code>, a directory used to store the data processed in <code>data-analysis</code> and <code>data-collection</code>. This directory is shared in both containers. <code>docker-compose.yml</code>, the Docker file that configures all containers used in the package. In the remainder of this document, we describe how to set up each container properly. <strong>Using VSCode to Setup the Package</strong> We selected VSCode as the IDE of choice because its extensions allow us to implement our scripts directly inside the containers. In this package, we provide configuration parameters for both <code>data-analysis</code> and <code>data-collection</code> containers. This way you can directly access and run each container inside it without any specific configuration. You first need to set up the containers <pre><code>$ cd /replication/package/folder $ docker-compose build $ docker-compose up # Wait docker creating and running all containers </code></pre> Then, you can open them in Visual Studio Code: Open VSCode in project root folder Access the command palette and select "Dev Container: Reopen in Container" Select either <em>Data Collection</em> or <em>Data Analysis</em>. Start working If you want/need a more customized organization, the remainder of this file describes it in detail. <strong>Longest Road: Manual Package Setup</strong> <strong>Database Setup</strong> The database container will automatically restore the dump in <code>dump_matroskin.tar</code> in its first launch. To set up and run the container, you should: Build an image: <pre><code>$ cd ./database $ docker build --tag 'dabc-database' . $ docker image ls REPOSITORY TAG IMAGE ID CREATED SIZE dabc-database latest b6f8af99c90d 50 minutes ago 18.5GB </code></pre> Create and enter inside the container: <pre><code class="language-bash">$ docker run -it --name dabc-database-1 dabc-database $ docker exec -it dabc-database-1 /bin/bash root# psql -U postgres -h localhost -d jupyter-notebooks jupyter-notebooks=# \dt List of relations Schema | Name | Type | Owner --------+-------------------+-------+------- public | Cell | table | root public | Code_cell | table | root public | Md_cell | table | root public | Notebook | table | root public | Notebook_features | table | root public | Notebook_metadata | table | root public | repository | table | root </code></pre> If you got the tables list as above, your database is properly setup. It is important to mention that this database is extended from the one provided by Grotov et al.. Basically, we added three columns in the table <code>Notebook_features</code> (<code>API_functions_calls</code>, <code>defined_functions_calls</code>, and<code>other_functions_calls</code>) containing the function calls performed by each client in the database. <strong>Data Collection Setup</strong> This container is responsible for collecting the data to answer our research questions. It has the following structure: <code>dabcs.py</code>, extract DABCs from Scikit Learn source code, and export them to a CSV file. <code>dabcs-clients.py</code>, extract function calls from clients and export them to a CSV file. We rely on a modified version of Matroskin to leverage the function calls. You can find the tool's source code in the `matroskin`` directory. <code>Makefile</code>, commands to set up and run both <code>dabcs.py</code> and <code>dabcs-clients.py</code> <code>matroskin</code>, the directory containing the modified version of matroskin tool. We extended the library to collect the function calls performed on the client notebooks of Grotov's dataset. <code>storage</code>, a docker volume where the data-collection should save the exported data. This data will be used later in Data Analysis. <code>requirements.txt</code>, Python dependencies adopted in this module. Note that the container will automatically configure this module for you, e.g., install dependencies, configure matroskin, download scikit learn source code, etc. For this, you must run the following commands: <pre><code class="language-bash">$ cd ./data-collection $ docker build --tag "data-collection" . $ docker run -it -d --name data-collection-1 -v $(pwd)/:/data-collection -v $(pwd)/../storage/:/data-collection/storage/ data-collection $ docker exec -it data-collection-1 /bin/bash $ ls Dockerfile Makefile config.yml dabcs-clients.py dabcs.py matroskin storage requirements.txt utils.py </code></pre> If you see project files, it means the container is configured accordingly. <strong>Data Analysis Setup</strong> We use this container to conduct the analysis over the data produced by the Data Collection container. It has the following structure: <code>dependencies.R</code>, an R script containing the dependencies used in our data analysis. <code>data-analysis.Rmd</code>, the R notebook we used to perform our data analysis <code>datasets</code>, a docker volume pointing to the <code>storage</code> directory. Execute the following commands to run this container: <pre><code class="language-bash">$ cd ./data-analysis $ docker build --tag "data-analysis" . $ docker run -it -d --name data-analysis-1 -v $(pwd)/:/data-analysis -v $(pwd)/../storage/:/data-collection/datasets/ data-analysis $ docker exec -it data-analysis-1 /bin/bash $ ls data-analysis.Rmd datasets dependencies.R Dockerfile figures Makefile </code></pre> If you see project files, it means the container is configured accordingly. A note on <code>storage</code> shared folder As mentioned, the <code>storage</code> folder is mounted as a volume and shared between <code>data-collection</code> and <code>data-analysis</code> containers. We compressed the content of this folder due to space constraints. Therefore, before starting working on Data Collection or Data Analysis, make sure you extracted the compressed files. You can do this by running the <code>Makefile</code> inside <code>storage</code> folder. <pre><code class="language-bash">$ make unzip # extract files $ ls clients-dabcs.csv clients-validation.csv dabcs.csv Makefile scikit-learn-versions.csv versions.csv $ make zip # compress files $ ls csv-files.tar.gz Makefile</code></pre>