pisa icon indicating copy to clipboard operation
pisa copied to clipboard

Documentation outdated

Open mpetri opened this issue 5 years ago • 1 comments

Describe the bug The docs at https://pisa.readthedocs.io/en/latest/compress_index.html#usage talk about using create_freq_index which is what the binary was called in ds2i. It looks like it was renamed to compress_inverted_index and additional features were added?

To Reproduce Steps to reproduce the behavior:

  1. Go to the docs
  2. Find the old description

Expected behavior The docs should provide a step-by-step guide to create an index. The create_wand_data step seems to be also missing? Is that still necessary?

mpetri avatar Jun 01 '20 14:06 mpetri

This is evidently a major issue with PISA currently. It's difficult for newbies to get going with it.

I think what would be super useful is to follow the Anserini "Reproducibility" path of providing end-to-end markdown files showing the process. See, for example: https://github.com/castorini/anserini/blob/master/docs/experiments-msmarco-passage.md

JMMackenzie avatar Aug 30 '21 23:08 JMMackenzie

We've upgraded the docs since this was opened, here's one link of interest: https://pisa.readthedocs.io/en/latest/experiments/regression-robust04.html

elshize avatar Feb 09 '23 02:02 elshize