catalyst-team / catalyst

Accelerated deep learning R&D
https://catalyst-team.com
Apache License 2.0
3.3k stars 388 forks source link

Columns and DataType Not Explicitly Set on line 96 of report.py #1449

Closed CodeSmileBot closed 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/catalyst-team/catalyst/blob/fccfb60ca684dd74a9abe20a981d87a04992dbb6/catalyst/contrib/utils/report.py#L86-L106.

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

File: https://github.com/catalyst-team/catalyst/blob/master/catalyst/contrib/datasets/movielens.py#L550-L560 Line: 555 File: https://github.com/catalyst-team/catalyst/blob/master/catalyst/contrib/datasets/movielens.py#L551-L561 Line: 556 File: https://github.com/catalyst-team/catalyst/blob/master/catalyst/contrib/datasets/movielens.py#L552-L562 Line: 557 File: https://github.com/catalyst-team/catalyst/blob/master/catalyst/contrib/datasets/movielens.py#L555-L565 Line: 560 File: https://github.com/catalyst-team/catalyst/blob/master/catalyst/contrib/datasets/movielens.py#L556-L566 Line: 561 .

I hope this information is helpful!

github-actions[bot] commented 1 year ago

Hi! Thank you for your contribution! Please re-check all issue template checklists - unfilled issues would be closed automatically. And do not forget to join our slack for collaboration.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.