Other improvements

[ricardoevvargas]

By creating this pull request, I confirm that I have read and fully accept and agree with one of the Petrobras' Contributor License Agreements (CLAs):

• ICLA: Individual Contributor License Agreement on behalf of only yourself;
• CCLA: Corporate Contributor License Agreement on behalf of your employer.

Our CLAs are based on the Apache Software Foundation's CLAs:

• ICLA: Individual Contributor License Agreement
• CCLA: Corporate Contributor License Agreement

---

This PR is related to PR #98 and proposes the following:

• README.md, main.ipynb and misc.py will be updated as suggested in PR Make code platform independent #98;
• misc.py proposed in PR Make code platform independent #98 will be reformated with Black;
• environment.yml proposed in PR Make code platform independent #98 will be replaced by a less restrictive version, which only specifies packages and their respective versions to be installed. Dependencies can be resolved by conda in different ways on different operating systems. As explained in PR Make code platform independent #98, we are studying alternatives, whether with conda or other tools, that promote reproducibility on different operating systems and at the same time reduce restrictions on the .yml file (or alternative format). By the way, suggestions are welcome.

[ricardoevvargas]

@afraniomelo, could you assess whether this less restrictive environment.yml is an appropriate evolution while we don't complete the study on alternatives?

[ricardoevvargas]

@pivettamarcos, could you confirm that on OS other than Windows conda generates a virtual environment from this less restrictive environment.yml (proposed in this PR) in which Jupyter notebooks contained in the 3W project work without errors? I don't have easy access to other operational systems nowadays but this can be done with $ conda env create -f environment.yml.

I'm talking about the following Jupyter notebooks:

• https://github.com/petrobras/3W/blob/main/overviews/_baseline/main.ipynb
• https://github.com/petrobras/3W/blob/main/overviews/AndreMachado/main.ipynb.

Important:

• At this moment, overviews proposed by @afraniomelo and the https://github.com/petrobras/3W/blob/main/problems/01_binary_classifier_of_spurious_closure_of_dhsv/_baseline/main.ipynb are broken. These overviews try to get files from Kaggle and this baseline is impacted by issue Missing instances in folds_clf_02.csv #70. Contributions will be welcome;
• We need to automate this type of confirmation. In fact, it's important to have unit tests, actions and other resources to ensure that one-off adjustments break the 3W toolkit, overviews, and baselines. Contributions in this regard will also be welcome.

[ricardoevvargas]

It seems that @afraniomelo and @pivettamarcos weren't available, but I had access to a computer with Fedora 34 and I was able to confirm that at least in this Linux distribution, conda generates a virtual environment from this less restrictive environment.yml (proposed in this PR) in which the 2 Jupyter notebooks mentioned work without errors. In fact, I noticed a problem in the overview created by @AndrePauloFM, specifically in the use of pandas_profiling, which has been replaced by ydata-profiling. As this is another problem, I'll create an issue to deal with it and merge this PR.