https://github.com/devrimcavusoglu/irise-retrieval-system
IR System Implementation for the course project METU CENG596 '24
https://github.com/devrimcavusoglu/irise-retrieval-system
Last synced: 6 months ago
JSON representation
IR System Implementation for the course project METU CENG596 '24
- Host: GitHub
- URL: https://github.com/devrimcavusoglu/irise-retrieval-system
- Owner: devrimcavusoglu
- License: apache-2.0
- Created: 2024-04-13T12:00:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-23T21:20:09.000Z (over 1 year ago)
- Last Synced: 2025-03-01T09:45:32.675Z (over 1 year ago)
- Language: Jupyter Notebook
- Size: 1.81 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IRise Retrieval System
A simple retrieval system designed as a retrieve-and-rerank methodology. A high-level system overview is provided below.
## Setup
Create a conda environment with the configuration file, and activate the environment when necessary.
```shell
conda env create -f environment.yml
```
activate the environment by
```shell
conda activate irise
```
## Indexing
Index your data by running the command below:
```shell
python -m irise index
```
This will use default variables for indexing path, etc. To see supported and customizable arguments, see
```shell
python -m irise index --help
```
## User Interface
The user interface designed as a web based UI with [streamlit](https://streamlit.io/). Run the following command at the project root.
```shell
streamlit run dashboard/app.py
```
## Development
For convenience add the project root to PYTHONPATH, earlier conda versions support this by `develop` command, run
```shell
conda develop /path/to/project_root
```
However, `conda develop` is deprecated for recent versions, you can manually add the project root to PYTHONPATH by
```shell
export PYTHONPATH="${PYTHONPATH}:/path/to/project_root"
```
Open Pull Request accordingly :).
## License
Copyright © 2024, Devrim Cavusoglu & Ezgi Çavaş.
Licensed under Apache 2.0 License.