Update README.md

README.md

@@ -33,3 +33,58 @@ After comprehensive testing against various models such as corrius/cross-encoder
 #### Advantages
 - **Improved Accuracy**: Leads to more precise responses from the chatbot, significantly enhancing user experience.
 - **Market Relevance**: Offers a competitive edge in German-speaking markets by effectively managing complex queries.
+
+# Integrating an ONNX Model with Metarank for German Text Re-ranking
+
+## Setup Local Metarank Instance
+
+To run Metarank locally, you need to create a `config.yml` file and set up a Docker container. Below are the detailed steps:
+
+### Step 1: Create Configuration File
+
+Create a `config.yml` file in the root of your Metarank project:
+
+```yaml
+inference:
+  msmarco:
+    type: cross-encoder
+    model: UlanYisaev/msmarco-MiniLM-L12-en-de-v1
+```
+
+### Step 2: Run Metarank using Docker
+```bash
+cd metarank
+docker run --name metarank -p 8080:8080 -v $(pwd):/opt/metarank metarank/metarank:latest serve --config /opt/metarank/config.yml
+```
+
+### Step 3: Configure Metarank Docker Image to Include config.yml
+Adjust the Docker configuration to include the config.yml in the build:
+```bash
+# Modify build.sbt in Metarank to include the custom script and config
+new Dockerfile {
+    add(new File("deploy/metarank_custom.sh"), "/metarank.sh")
+    add(new File("config.yml"), "/opt/metarank/config.yml")
+    entryPoint("/metarank.sh")
+    cmd("--help")
+}
+
+# Build the Docker image
+sbt docker
+```
+
+deploy/metarank_custom.sh:
+```bash
+#!/bin/bash
+
+set -euxo pipefail
+OPTS=${JAVA_OPTS:-"-Xmx1700m -verbose:gc"}
+
+exec /usr/bin/java $OPTS -cp "/app/*" ai.metarank.main.Main serve --config /opt/metarank/config.yml
+```
+
+### Step 4: Run and Manage the Docker Container
+```bash
+docker run --name metarank -p 8080:8080 metarank/metarank:0.7.8-amd64
+docker stop metarank
+docker start metarank
+```