allegroai / clearml

ClearML - Auto-Magical CI/CD to streamline your AI workload. Experiment Management, Data Management, Pipeline, Orchestration, Scheduling & Serving in one MLOps/LLMOps solution
https://clear.ml/docs
Apache License 2.0
5.61k stars 651 forks source link

Columns and DataType Not Explicitly Set on line 19 of pandas_reporting.py #1066

Open CodeSmileBot opened 1 year ago

CodeSmileBot commented 1 year ago

Hello!

I found an AI-Specific Code smell in your project. The smell is called: Columns and DataType Not Explicitly Set

You can find more information about it in this paper: https://dl.acm.org/doi/abs/10.1145/3522664.3528620.

According to the paper, the smell is described as follows:

Problem If the columns are not selected explicitly, it is not easy for developers to know what to expect in the downstream data schema. If the datatype is not set explicitly, it may silently continue the next step even though the input is unexpected, which may cause errors later. The same applies to other data importing scenarios.
Solution It is recommended to set the columns and DataType explicitly in data processing.
Impact Readability

Example:


### Pandas Column Selection
import pandas as pd
df = pd.read_csv('data.csv')
+ df = df[['col1', 'col2', 'col3']]

### Pandas Set DataType
import pandas as pd
- df = pd.read_csv('data.csv')
+ df = pd.read_csv('data.csv', dtype={'col1': 'str', 'col2': 'int', 'col3': 'float'})

You can find the code related to this smell in this link: https://github.com/allegroai/clearml/blob/b4942321340563724bc16f60ea5dd78c9161778d/examples/reporting/pandas_reporting.py#L9-L29.

I also found instances of this smell in other files, such as:

File: https://github.com/allegroai/trains/blob/master/clearml/logger.py#L375-L385 Line: 380 File: https://github.com/allegroai/trains/blob/master/clearml/logger.py#L377-L387 Line: 382 File: https://github.com/allegroai/trains/blob/master/clearml/model.py#L632-L642 Line: 637 File: https://github.com/allegroai/trains/blob/master/clearml/model.py#L634-L644 Line: 639 File: https://github.com/allegroai/trains/blob/master/clearml/binding/artifacts.py#L184-L194 Line: 189 .

I hope this information is helpful!