Columns and DataType Not Explicitly Set on line 147 of wordembedding_utils.py

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:

FARM/farm/modeling/wordembedding_utils.py

Lines 137 to 157 in 94c6b8d

    
                   resolved_model_file = load_from_cache(self.pretrained_model_name_or_path, EMBEDDING_MODEL_MAP, **kwargs) 
        
               if os.path.isfile(resolved_model_file): 
        
                   model = self.fasttext.load_model(resolved_model_file) 
        
               else: 
        
                   logger.error(f"Could not load fasttext model at {self.pretrained_model_name_or_path}.") 
        
               return model 
        
           def _load_data(self): 
        
               # Data loading 
        
               df = pd.read_csv(str(self.data_path / self.train_filename), sep=self.sep, nrows=self.max_inputdata_rows) 
        
               if self.text_column_name not in df.columns: 
        
                   logger.error( 
        
                       f"Cannot find Text column name in the supplied data. Available columsn are {', '.join(df.columns)}.") 
        
               if self.max_inputdata_rows: 
        
                   df = df.sample(n=self.max_inputdata_rows) 
        
               texts = df.loc[:, self.text_column_name].values 
        
               all_words = [] 
        
               for t in texts: 
        
                   if self.do_lower_case:

.

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

File: https://github.com/deepset-ai/FARM/blob/master/farm/utils.py#L352-L362 Line: 357
File: https://github.com/deepset-ai/FARM/blob/master/farm/utils.py#L420-L430 Line: 425
File: https://github.com/deepset-ai/FARM/blob/master/farm/evaluation/msmarco_passage_farm.py#L70-L80 Line: 75
.

I hope this information is helpful!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	resolved_model_file = load_from_cache(self.pretrained_model_name_or_path, EMBEDDING_MODEL_MAP, **kwargs)
	if os.path.isfile(resolved_model_file):
	model = self.fasttext.load_model(resolved_model_file)
	else:
	logger.error(f"Could not load fasttext model at {self.pretrained_model_name_or_path}.")

	return model

	def _load_data(self):
	# Data loading
	df = pd.read_csv(str(self.data_path / self.train_filename), sep=self.sep, nrows=self.max_inputdata_rows)

	if self.text_column_name not in df.columns:
	logger.error(
	f"Cannot find Text column name in the supplied data. Available columsn are {', '.join(df.columns)}.")
	if self.max_inputdata_rows:
	df = df.sample(n=self.max_inputdata_rows)
	texts = df.loc[:, self.text_column_name].values
	all_words = []
	for t in texts:
	if self.do_lower_case:

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions