Metadata-Version: 2.1
Name: pygaggle
Version: 0.0.1
Summary: A gaggle of rerankers for CovidQA and CORD-19
Home-page: https://github.com/castorini/pygaggle
Author: PyGaggle Gaggle
Author-email: r33tang@uwaterloo.ca
License: UNKNOWN
Description: # PyGaggle
        
        A gaggle of rerankers for [CovidQA](https://github.com/castorini/pygaggle/blob/master/data/) and CORD-19. 
        
        ## Installation
        
        1. For pip, do `pip install pygaggle`. If you prefer Anaconda, use `conda env create -f environment.yml && conda activate pygaggle`.
        
        2. Install [PyTorch 1.4+](http://pytorch.org/).
        
        3. Download the index: `sh scripts/update-index.sh`.
        
        4. Make sure you have an installation of Java 11+: `javac --version`.
        
        5. Install [Anserini](https://github.com/castorini/anserini).
        
        
        ## Running rerankers on CovidQA
        
        By default, the script uses `data/lucene-index-covid-paragraph` for the index path.
        If this is undesirable, set the environment variable `CORD19_INDEX_PATH` to the path of the index.
        
        
        ### Unsupervised Methods
        
        **BM25**: `python -um pygaggle.run.evaluate_kaggle_highlighter --method bm25`
        
        **BERT**: `python -um pygaggle.run.evaluate_kaggle_highlighter --method transformer --model-name bert-base-cased`
        
        **SciBERT**: `python -um pygaggle.run.evaluate_kaggle_highlighter --method transformer --model-name allenai/scibert_scivocab_cased`
        
        **BioBERT**: `python -um pygaggle.run.evaluate_kaggle_highlighter --method transformer --model-name biobert`
        
        
        ### Supervised Methods
        
        **T5 (MARCO)**: `python -um pygaggle.run.evaluate_kaggle_highlighter --method t5`
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
