Skip to main content

refy

A papers recomendation tool

refy compares papers in your library against a database of scientific papers to find new papers that you might be interested in. While there's a few services out there that try to do the same, refy is unique in several ways:

  • refy is completely open source, you can get the code and tweak it to improve the recomendation engine
  • refy doesn't just use a single paper or a subset of (overly generic) keywords to find new papers, instead it compares all of your papers' abstracts against a database of papers metadata, producing much more relevant results

disclaimer

The dataset used here is a subset of a larger dataset of scientific papers. The dataset if focused on neuroscience papers published in the latest 30 years. If you want to include older papers or are interested in another field, then follow the instructions to create your custom database.

(possible) future improvements

  • use scibert instead of tf-idf for creating the embedding. This should also make it possible to embed the database's papers before use (unlike tf-idf which needs to run on the entire corpus every time).

Overview

The core feature making refy unique among papers recomendation systems is that it analyzes your entire library of papers and matches it against a vast database of scientific papers to find new relevant papers. This is obviously an improvement compared e.g. to finding papers similar to one paper you like. In addition, refy doesn't just use things like "title", "authors", "keywords"... to find new matches, instead it finds similar papers using Term Frequency-Inverse Document Frequency to asses the similarity across papers abstracts, thus using much more information about the papers' content.

Usage

First, you need to get data about your papers you want to use for the search. The best way is to export your library (or a subset of it) directly to a .bib file using your references menager of choice.

Then, you can use...

Making your own database

refy uses a subset of the vast and eccelent corpus of scientific publications' metadata from Semanthic Scholar. The dataset used by refy is focused on neuroscience papers written in english and published in the last 30 years. If you wish to include a different set of papers in your database, you can make your custom database and use it with refy by executing the following steps.

1. Download whole corpus

You'll first need to download the whole corpus from Semantic Scholar. You can find the data and download instructions here. Once the data are downloaded, save them in a folder where you want to base your dataset-creation process

2. Uncompressing data

The downloaded corpus is compressed. To uncompress the files use refy.database_preprocessing.upack_database pasing to it the path to the folder where you've downloaded the data.

3. Specifying your parameters

The selection of a subset of papers from the corpus is based on a set of parameters (e.g. year of publication) matched against criteria specified (and described) in refy.settings. Edit the criteria to adapt the dataset selection to your needs

4. Creating the dataset

Simply run refy.database_preprocessing.make_database

5. Training doc2vec model

Papers semanthic similarity is estimated using a doc2vec model trained on the entire dataset. After modifying the dataset to your needs, you'll have to re-train the model by running refy.doc2vec.train_doc2vec_model

summary:

An example code for creating your dataset (after having downloaded the corpus and edited the settings)

from refy.database_preprocessing import upack_database, make_database
from refy.doc2vec import train_doc2vec_model
from pathlib import Path

folder = Path('path to your data')

# unpack and create
unpack_database(folder)
make_database(folder)

# train new d2v model
train_doc2vec_model()

Metadata

Release files for refy 0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for refy 0
File Size Uploaded
refy-0.tar.gz 17.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for refy 0
File Interpreter ABI Platform
refy-0-py3-none-any.whl Python 3 none any Details

Total release size: 39.0 kB

Release files / refy-0.tar.gz

Download URL refy-0.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e1f1eaacefa8c880e7e6ac2b37cae2bd8f2a19ca1e58a4c95ebb6e2dffb616bc
BLAKE2b-256 checksum
How to use checksums
70cc4bf52c0f0c5cd94c99bc2c4f519692b16a59413db54d3f7a8ea732232399
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.4

Release files / refy-0-py3-none-any.whl

Download URL refy-0-py3-none-any.whl
Size 21.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88997a361f056c6f7e3fd5a00b88baab08402e42e6e5fe3dcd0478e4542fb2e3
BLAKE2b-256 checksum
How to use checksums
d07ba7bef74249fdba2ad598054f08ce9a704ea19e14453bc286fd58ff1acd2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page