deezer / deezer/spleeter

Columns and DataType Not Explicitly Set on line 65 of test_train.py

Open
#858 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
28.4k
Forks
3.1k
PR merge metrics
No merged PRs in 30d

Description

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:
```diff

### 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/deezer/spleeter/blob/19b523f081d04f09926763c679de48354f4e52d6/tests/test_train.py#L55-L75.

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

File: https://github.com/deezer/spleeter/blob/master/spleeter/__main__.py#L178-L188 Line: 183
File: https://github.com/deezer/spleeter/blob/master/spleeter/utils/tensor.py#L149-L159 Line: 154
.

I hope this information is helpful!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.