Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
CodeSmileBot opened this issue Jul 4, 2023 · 2 comments
Closed
Labels
wontfix This will not be worked on

Comments

@CodeSmileBot
Copy link

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:

r_support = support / support.sum()
for average in avg_names:
avg_precision, avg_recall, avg_f1, _ = precision_recall_fscore_support(
y_true=y_true, y_pred=y_pred, average=average, labels=labels
)
avg_metrics = avg_precision, avg_recall, avg_f1
for k, v in zip(metrics_names[:4], avg_metrics):
metrics[k][average] = v
report = pd.DataFrame(
[precision, recall, f1, auc, support, r_support],
columns=labels,
index=metrics_names,
).T
if beta is not None:
_, _, fbeta, _ = precision_recall_fscore_support(
y_true=y_true, y_pred=y_pred, average=None, beta=beta, labels=labels
)
avg_fbeta = np.zeros(len(avg_names))
.

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
Copy link

github-actions bot commented Jul 4, 2023

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
Copy link

stale bot commented Sep 17, 2023

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.

@stale stale bot added the wontfix This will not be worked on label Sep 17, 2023
@stale stale bot closed this as completed Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant