rubenkruiper / irrec

IRReC: Information Retrieval over building regulations, part of the Intelligent Regulatory Compliance (iReC) project at Northumbria University.

Information Retrieval for Regulatory Compliance (IRReC)

---

The Information Retrieval for Regulatory Compliance (IRReC) provides an experimental search engine to search over building regulations. Due to licensing restrictions you will have to provide your own regulations in .pdf format. This repository contains code and some of the data for the IRReC system, published at EG-ICE 2023. The paper can be found here.

The IR system and experiments are all written in python. Instructions for preparing the system, running experiments and running a local front end to call the system API are provided in each of the corresponding folders.

We hope that our data and code will help you research Information Retrieval in the domain of Architecture, Engineering and Construction. Note that the code in this project for Named Entity Recognition (NER) and automatically creating a span-based Knowledge Graph (KG) has been published separately as well, see:

• SPaR.txt shallower parser for NER
• iReC KG from building regulations

If you use our work in one of your projects, please consider referencing our paper:

@inproceedings{Kruiper2023_IRReC,
   title = "Document and Query Expansion for Information Retrieval on Building Regulations",
    author = "Kruiper, Ruben  and
      Konstas, Ioannis  and
      Gray, Alasdair J.G.  and
      Sadeghineko, Farhad  and
      Watson, Richard  and
      Kumar, Bimal",
    month = jul,
    year = "2023",
    keywords= "Information Retrieval,Building Regulations,Query Expansion,Document Expansion",
}

Figure: Overview of approach, also see our paper:

The code and data in this repository are licensed under a Creative Commons Attribution 4.0 License.

irrec's Issues

additionalProp1 added in settings of QE api

See: additionalProp1 now showing on all auto-generated examples in openapi after upgrade to 0.99

Need to figure out the proper new versions of fastapi and pydantic, as well as import of BaseSettings etc that have been deprecated.

Update SPaR.txt

Upgrade to the new SPaR.txt container and calls.