irlab

Make IR research efficient/


Explore the docs »




View Demo
·
Report Bug
·
Request Feature

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/Ankush-Chander/irlab.git

2. Install via pip

   cd irlab
   pip install -e .

Usage

from irlab import ResultSet
old_rs = ResultSet(primary_key="doc_id", response_key=None)
old_rs.load_json("dat/old_results.json")
new_rs = ResultSet(primary_key="doc_id", response_key=None)
new_rs.load_json("dat/new_results.json")
# view results not found in new result set 
(old_rs - new_rs).view_data()
# view common results
old_rs.intersection(new_rs).view_data()

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ankush Chander - @AnkushChander - ankush@wandlore.in

Project Link: https://github.com/Ankush-Chander/irlab