This repository focuses on an approach exploring and assessing literature-based doc-2-doc recommendations using the fastText algorithm with its application to the RELISH dataset.
Our approach employs the FastText library to generate word embeddings and subsequently employs a centroid aggregration technique to produce document-level embeddings. This process involves calculating the centroids of word embeddings found in the titles and abstracts of each document. The approach is applied to evaluate literature-based document-to-document recommendations using the RELISH dataset.
The input data for this method consists of preprocessed tokens derived from the RELISH documents. These tokens are stored in the RELISH.npy file, which contains preprocessed arrays comprising PMIDs, document titles, and abstracts. These arrays are generated through an extensive preprocessing pipeline, as elaborated in the relish-preprocessing repository. Within this preprocessing pipeline, both the title and abstract texts undergo several stages of refinement: structural words are eliminated, text is converted to lowercase, stop words are removed and finally, tokenization is employed, resulting in arrays of individual words.
This section outlines the progression from generating document embeddings to conducting hyperparameter optimization and ultimately evaluating the effectiveness of the approach.
The following section outlines the process of generating document-level embeddings for each PMID of the RELISH corpus using trained fastText models. We employ the parameters shown below in order to generate our models.
- sg: {1,0} Refers to the training algorithm. If sg=1, skip-gram is used otherwise, continuous bag of words is used.
- vector_size: It represents the dimensions of the generated embeddings, with options of 200, 300 and 400 in our case.
- window: Represents the maximum distance between the current and predicted word, with values fof 5,6 and 7 in our case.
- epochs: Refers to the number of iterations over the training dataseta and is set at 15 in this context.
- min_count: It is the minimum number of appearances a word must have to not be ignored by the algorithm and is configured at a minimum of 5.
After model training, we can extract document-level embeddings. These embeddings are numerical vectors that represent the content and context of each document in a continuous vector space. These embeddings are stored by the model, associated with each PMID. For further downstream document similarity calculations, we format and save these embeddings for each document with its PMID as a dataframe in a pickle file. Each specific set of hyperparameter combination results in having a separate pickle file.
To assess the similarity between two documents within the RELISH corpus, we employ the Cosine Similarity metric. This process enables the generation of a 4-column matrix containing cosine similarity scores for existing pairs of PMIDs within our corpus. For a more detailed explanation of the process, please refer to this documentation.
In order to evaluate the effectiveness of this approach, we make use of Precision@N. Precision@N measures the precision of retrieved documents at various cutoff points (N).We generate a Precision@N matrix for existing pairs of documents within the RELISH corpus, based on the original RELISH JSON file. The code determines the number of true positives within the top N pairs and computes Precision@N scores. The result is a Precision@N matrix with values at different cutoff points, including average scores. For detailed insights into the algorithm, please refer to this documentation.
Another metric used is the nDCG@N (normalized Discounted Cumulative Gain). This ranking metric assesses document retrieval quality by considering both relevance and document ranking. It operates by using a TSV file containing relevance and cosine similarity scores, involving the computation of DCG@N and iDCG@N scores. The result is an nDCG@N matrix for various cutoff values (N) and each PMID in the corpus, with detailed information available in the documentation.
To get started with this project, follow these steps:
First, clone the repository to your local machine using the following command:
git clone https://github.com/zbmed-semtec/fasttext2doc2vec-doc-relevance.git
Ensure you have set up SSH keys in your GitHub account.
git clone git@github.com:zbmed-semtec/fasttext2doc2vec-doc-relevance.git
To create a virtual environment within your repository, run the following command:
python3 -m venv .venv
source .venv/bin/activate # On Windows, use '.venv\Scripts\activate'
To confirm if the virtual environment is activated and check the location of yourPython interpreter, run the following command:
which python # On Windows command prompt, use 'where python'
# On Windows PowerShell, use 'Get-Command python'
The code is stable with python 3.6 and higher. The required python packages are listed in the requirements.txt file. To install the required packages, run the following command:
pip install -r requirements.txt
To deactivate the virtual environment after running the project, run the following command:
deactivate
Use the Download_Dataset.sh script to download the Split Dataset by running the following commands:
chmod +777 Download_Dataset.sh
./Download_Dataset.sh
This script makes sure that the necessary folders are created and the files are downloaded in the corresponding folders as shown below.
π¦ /fasttext2doc2vec-doc-relevance
ββ data
ββ Input
ββ Tokens
β ββ relish.npy
ββ Ground_truth
ββ relevance_matrix.tsv
The embeddings.py script uses the RELISH Tokenized npy file as input. You can easily adapt it for different values and parameters by modifying the hyperparameters.yaml . Make sure to have the RELISH Tokenized.npy file within the directory under the data folder.
python3 code/embeddings.py [-i INPUT PATH] [-o OUTPUT PATH] [-p PARAMS]
You must pass the following arguments:
- -i/ --input : File path to the RELISH tokenized .npy file.
- -o/ --output : File path to the resulting embeddings in pickle file format.
- -p/ --params : File path to the hyperparameters YAML file.
To run this script, please execute the following command:
python3 code/embeddings.py --input data/Input/Tokens/relish.npy --output data/embeddings --params code/hyperparameters.yaml
The script will create fastText models, generate embeddings, and store them in separate directories. You should expect to find a total of 18 files corresponding to the various models, embeddings, and embedding pickle files.
In order to generate the cosine similarity matrix and execute this script, run the following command:
python3 code/generate_cosine_existing_pairs.py [-i INPUT] [-e EMBEDDINGS] [-o OUTPUT]
You must pass the following four arguments:
- -i/ --input : File path to the RELISH relevance matrix in the TSV format.
- -e/ --embeddings : File path to the embeddings in the pickle file format.
- -o/ --output : File path for the output 4 column cosine similarity matrix.
For example, if you are running the code from the code folder and have the RELISH relevance matrix in the data folder, run the cosine matrix creation for the first hyperparameter as:
python3 code/generate_cosine_existing_pairs.py -i data/Input/Ground_truth/relevance_matrix.tsv -e data/embeddings/embeddings_0.pkl -o data/cosine/cosine_similarity_0.tsv
Note: You would have to run the above command for every hyperparameter configuration by changing the file name for the embedding's pickle file or use the following shell script to generate all files at once.
for VALUE in {0..17};do
python3 code/generate_cosine_existing_pairs.py -i data/Input/Ground_truth/relevance_matrix.tsv -e data/embeddings/embeddings_pickle_${VALUE}.pkl -o data/cosine/cosine_similarity_${VALUE}.tsv
done
In order to calculate the Precision@N scores and execute this script, run the follwing command:
python3 code/precision.py [-i COSINE FILE PATH] [-o OUTPUT PATH]
You must pass the following two arguments:
- -i/ --cosine_file_path: path to the 4-column cosine similarity existing pairs RELISH file: (tsv file)
- -o/ --output_path: path to save the generated precision matrix: (tsv file)
For example, if you are running the code from the code folder and have the cosine similarity TSV file in the data folder, run the precision matrix creation for the first hyperparameter as:
python3 code/precision.py -c data/cosine_similarity_0.tsv -o data/precision_fasttext_0.tsv
Note: You would have to run the above command for every hyperparameter configuration by changing the file name for the cosine similarity file or use the following shell script to generate all files at once.
for VALUE in {0..17};do
python3 code/precision.py -c data/cosine_similarity_${VALUE}.tsv -o data/precision_three_classes/precision_${VALUE}.tsv -c 3
done
Note: Make sure to re-run the above command by changing the classes for a different class distribution.
In order to calculate nDCG scores and execute this script, run the following command:
python3 code/calculate_gain.py [-i INPUT] [-o OUTPUT]
You must pass the following two arguments:
- -i / --input: Path to the 4 column cosine similarity existing pairs RELISH TSV file.
- -o/ --output: Output path along with the name of the file to save the generated nDCG@N TSV file.
For example, if you are running the code from the code folder and have the 4 column RELISH TSV file in the data folder, run the matrix creation for the first hyperparameter as:
python3 code/calculate_gain.py -i data/cosine_similarity_0.tsv -o data/ndcg_fasttext_0.tsv
Note: You would have to run the above command for every hyperparameter configuration by changing the file name for the cosine similarity file or use the following shell script to generate all files at once.
for VALUE in {0..17};do
python3 code/calculate_gain.py -i data/cosine/cosine_similarity_${VALUE}.tsv -o data/gain/ndcg_${VALUE}.tsv
done
In order to compile the average result values for Precison@ and nDCG@N and generate a single TSV file each, please use this script.
You must pass the following two arguments:
- -i / --input: Path to the directory consisting of all the precision matrices/gain matrices.
- -o/ --output: Output path along with the name of the file to save the generated compiled Precision@N / nDCG@N TSV file.
If you are running the code from the code folder, run the compilation script as:
python3 code/show_avg.py -i data/gain_matrices/ -o data/results_gain.tsv
NOTE: Please do not forget to put a '/' at the end of the input file path.