An open API service indexing awesome lists of open source software.

https://github.com/ankush-chander/irlab

Make IR research faster.
https://github.com/ankush-chander/irlab

evaluation experimentation information-retrieval recommender-systems

Last synced: 11 months ago
JSON representation

Make IR research faster.

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



irlab


Make IR research efficient/


Explore the docs »




View Demo
·
Report Bug
·
Request Feature

Table of Contents



  1. Getting Started


  2. Usage

  3. Roadmap

  4. Contributing

  5. License

  6. Contact

## Getting Started

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

### Installation

1. Clone the repo
```sh
git clone https://github.com/Ankush-Chander/irlab.git
```
2. Install via pip
```sh
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](https://github.com/Ankush-Chander/irlab/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](https://twitter.com/AnkushChander) - ankush@wandlore.in

Project Link: [https://github.com/Ankush-Chander/irlab](https://github.com/Ankush-Chander/irlab)

[contributors-shield]: https://img.shields.io/github/contributors/Ankush-Chander/irlab.svg?style=for-the-badge
[contributors-url]: https://github.com/Ankush-Chander/irlab/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Ankush-Chander/irlab.svg?style=for-the-badge
[forks-url]: https://github.com/Ankush-Chander/irlab/network/members
[stars-shield]: https://img.shields.io/github/stars/Ankush-Chander/irlab.svg?style=for-the-badge
[stars-url]: https://github.com/Ankush-Chander/irlab/stargazers
[issues-shield]: https://img.shields.io/github/issues/Ankush-Chander/irlab.svg?style=for-the-badge
[issues-url]: https://github.com/Ankush-Chander/irlab/issues
[license-shield]: https://img.shields.io/github/license/Ankush-Chander/irlab.svg?style=for-the-badge
[license-url]: https://github.com/Ankush-Chander/irlab/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/ankush-chander-8248a876/