flow-project / flow

Computational framework for reinforcement learning in traffic control
MIT License
1.04k stars 369 forks source link

Columns and DataType Not Explicitly Set on line 69 of time_space_diagram.py #1079

Open CodeSmileBot opened 7 months ago

CodeSmileBot commented 7 months 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/flow-project/flow/blob/d36da2e5144a40072b11e39f9da6725cc3f4441e/flow/visualize/time_space_diagram.py#L59-L79.

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

.

I hope this information is helpful!