add dev container support

Signed-off-by: Zhao Junwang <[email protected]>

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.11-buster as builder-image
+
+RUN apt-get update
+
+COPY ../install/requirements_py3.11.txt .
+RUN pip3 install -U pip
+RUN pip3 install --no-cache-dir -r requirements_py3.11.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
+
+WORKDIR /opt/code
+ENV PYTHONPATH /opt/code/VectorDBBench

.devcontainer/devcontainer.json

@@ -0,0 +1,47 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
+{
+	"name": "VectorDBBench dev container",
+	"build": {
+		// Sets the run context to one level up instead of the .devcontainer folder.
+		"context": "..",
+		// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
+		"dockerfile": "./Dockerfile"
+	},
+	"runArgs": [
+		"--privileged",
+		"--cap-add=SYS_PTRACE"
+	],
+	"mounts": [
+		// You have to make sure source directory is avaliable on your host file system.
+		"source=${localEnv:HOME}/vectordb_bench/dataset,target=/tmp/vectordb_bench/dataset,type=bind,consistency=cached"
+	],
+	"workspaceMount": "source=${localWorkspaceFolder},target=/opt/code/VectorDBBench,type=bind,consistency=cached",
+	"workspaceFolder": "/opt/code/VectorDBBench",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [
+		8501
+	],
+
+	// Uncomment the next line to run commands after the container is created.
+	// "postCreateCommand": "cat /etc/os-release",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"eamodio.gitlens",
+				"ms-python.python",
+				"ms-python.debugpy",
+				"ms-azuretools.vscode-docker"
+			]
+		}
+	}
+
+	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "devcontainer"
+}

README.md

@@ -90,6 +90,19 @@ OR:
 ```shell
 $ init_bench
 ```
+
+OR:
+
+If you are using [dev container](https://code.visualstudio.com/docs/devcontainers/containers), create
+the following dataset directory first:
+
+```shell
+# Mount local ~/vectordb_bench/dataset to contain's /tmp/vectordb_bench/dataset.
+# If you are not comfortable with the path name, feel free to change it in devcontainer.json
+mkdir -p ~/vectordb_bench/dataset
+```
+After reopen the repository in container, run `python -m vectordb_bench` in the container's bash.
+
 ### Check coding styles
 ```shell
 $ ruff check vectordb_bench