Skip to content

StankovskiA/RepoFromPaper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RepoFromPaper

License Project Status: Moved to https://github.com/SoftwareUnderstanding/RSEF/ – The project has been moved to a new location, and the version at that location should be considered authoritative.

Description

This package is a tool to automatically detect and extract proposed repository links from academic papers. It uses a combination of natural language processing and heuristics to identify and extract the repository links mentioned in a proposal manner from a paper. The tool is designed to be used by researchers and developers who want to quickly find the code associated with a paper.

Table of Contents

Installation

The package has only three dependencies which are specified in the setup.py file. To install the package, you can use the following command:

pip install .

Usage

The usage of the package is very simple as it only has one main function. The function takes a string as input and returns a list of best matched sentences and the repository link if found else an empty string. Here is an example of how to use the package.

The name of the function is extract_repo_links_from_pdf and it takes the local path to the PDF as input. Here is an example of how to use the package.

from RSEF.repofrompaper.rfp.main import extract_repo_links_from_pdf

pdf_path = "path/to/pdf"
repo_links = extract_repo_links_from_pdf(pdf_path)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. If you have any questions, feel free to contact us.

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions, feel free to contact me at [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages