Instructions to use flowxai/semantic-mapper with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use flowxai/semantic-mapper with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="flowxai/semantic-mapper")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("flowxai/semantic-mapper")
model = AutoModelForCausalLM.from_pretrained("flowxai/semantic-mapper", device_map="auto")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

MLX

How to use flowxai/semantic-mapper with MLX:

# Make sure mlx-lm is installed
# pip install --upgrade mlx-lm

# Generate text with mlx-lm
from mlx_lm import load, generate

model, tokenizer = load("flowxai/semantic-mapper")

prompt = "Write a story about Einstein"
messages = [{"role": "user", "content": prompt}]
prompt = tokenizer.apply_chat_template(
    messages, add_generation_prompt=True
)

text = generate(model, tokenizer, prompt=prompt, verbose=True)

llama-cpp-python

How to use flowxai/semantic-mapper with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="flowxai/semantic-mapper",
	filename="gguf/semantic-mapper-4b-Q4_K_M.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use flowxai/semantic-mapper with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf flowxai/semantic-mapper:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf flowxai/semantic-mapper:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf flowxai/semantic-mapper:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf flowxai/semantic-mapper:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf flowxai/semantic-mapper:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf flowxai/semantic-mapper:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf flowxai/semantic-mapper:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf flowxai/semantic-mapper:Q4_K_M

Use Docker

docker model run hf.co/flowxai/semantic-mapper:Q4_K_M

LM Studio
Jan

vLLM

How to use flowxai/semantic-mapper with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "flowxai/semantic-mapper"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "flowxai/semantic-mapper",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/flowxai/semantic-mapper:Q4_K_M

SGLang

How to use flowxai/semantic-mapper with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "flowxai/semantic-mapper" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "flowxai/semantic-mapper",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "flowxai/semantic-mapper" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "flowxai/semantic-mapper",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use flowxai/semantic-mapper with Ollama:
```
ollama run hf.co/flowxai/semantic-mapper:Q4_K_M
```

Unsloth Studio

How to use flowxai/semantic-mapper with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for flowxai/semantic-mapper to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for flowxai/semantic-mapper to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for flowxai/semantic-mapper to start chatting

How to use flowxai/semantic-mapper with Pi:

Start the MLX server

# Install MLX LM:
uv tool install mlx-lm
# Start a local OpenAI-compatible server:
mlx_lm.server --model "flowxai/semantic-mapper"

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "mlx-lm": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "flowxai/semantic-mapper"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use flowxai/semantic-mapper with Hermes Agent:

Start the MLX server

# Install MLX LM:
uv tool install mlx-lm
# Start a local OpenAI-compatible server:
mlx_lm.server --model "flowxai/semantic-mapper"

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default flowxai/semantic-mapper

Run Hermes

hermes

Atomic Chat new

OpenClaw new

How to use flowxai/semantic-mapper with OpenClaw:

Start the MLX server

# Install MLX LM:
uv tool install mlx-lm
# Start a local OpenAI-compatible server:
mlx_lm.server --model "flowxai/semantic-mapper"

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "flowxai/semantic-mapper" \
  --custom-provider-id mlx-lm \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

MLX LM

How to use flowxai/semantic-mapper with MLX LM:

Generate or start a chat session

# Install MLX LM
uv tool install mlx-lm
# Interactive chat REPL
mlx_lm.chat --model "flowxai/semantic-mapper"

Run an OpenAI-compatible server

# Install MLX LM
uv tool install mlx-lm
# Start the server
mlx_lm.server --model "flowxai/semantic-mapper"
# Calling the OpenAI-compatible server with curl
curl -X POST "http://localhost:8000/v1/chat/completions" \
   -H "Content-Type: application/json" \
   --data '{
     "model": "flowxai/semantic-mapper",
     "messages": [
       {"role": "user", "content": "Hello"}
     ]
   }'

Docker Model Runner
How to use flowxai/semantic-mapper with Docker Model Runner:
```
docker model run hf.co/flowxai/semantic-mapper:Q4_K_M
```

Lemonade

How to use flowxai/semantic-mapper with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull flowxai/semantic-mapper:Q4_K_M

Run and chat with the model

lemonade run user.semantic-mapper-Q4_K_M

List all available models

lemonade list

semantic-mapper / inference_contract /schema_mapper_v1.json

bogdanraduta

Add inference_contract

1aca094 verified 16 days ago

Raw

History Blame Contribute Delete

4.26 kB

	{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://huggingface.co/flowxai/semantic-mapper/inference_contract/schema_mapper_v1.json",
	"title": "FlowX Semantic Mapper output (schema_mapper_v1)",
	"description": "The single JSON object the Semantic Mapper emits for one regulatory/legal text chunk. Three facets: structural, semantic, governance. Prompt version mapper_sys_v1.",
	"type": "object",
	"additionalProperties": false,
	"required": ["structural", "semantic", "governance"],
	"properties": {
	"structural": {
	"type": "object",
	"description": "Where the chunk sits in its source document.",
	"additionalProperties": false,
	"required": ["source_id", "hierarchy", "document_type"],
	"properties": {
	"source_id": {
	"type": "string",
	"description": "Stable identifier for the chunk, typically an uppercased normalization of the citation path (e.g. US_CA_INS_790_03_h_2)."
	},
	"hierarchy": {
	"type": "array",
	"description": "Ordered flat array of alternating [level, value] pairs from the outermost container down to the leaf (e.g. [\"state_code\",\"california_insurance_code\",\"section\",\"790.03\",\"subdivision\",\"h\",\"paragraph\",\"2\"]).",
	"items": { "type": "string" },
	"minItems": 2
	},
	"document_type": {
	"type": "string",
	"description": "Snake_case document class, e.g. state_insurance_code, eu_regulation, federal_regulation, labor_code, adr_agreement."
	}
	}
	},
	"semantic": {
	"type": "object",
	"description": "What the chunk is about.",
	"additionalProperties": false,
	"required": ["domain_tags", "concepts", "entities"],
	"properties": {
	"domain_tags": {
	"type": "array",
	"description": "Free snake_case topic tags (open vocabulary). Less consistent than concepts by design.",
	"items": { "type": "string" }
	},
	"concepts": {
	"type": "array",
	"description": "Concept ids drawn from the 252-concept controlled taxonomy (concept_taxonomy.yaml, shipped at repo root). Values SHOULD be in-vocabulary; out-of-vocabulary ids are treated as errors by downstream consumers.",
	"items": { "type": "string" }
	},
	"entities": {
	"type": "object",
	"description": "The core actor/action/object triple plus a constraint map.",
	"additionalProperties": false,
	"required": ["actor", "action", "object", "constraint"],
	"properties": {
	"actor": {
	"type": "string",
	"description": "Who the obligation/right falls on (e.g. insurer, employer, carrier, credit_institution)."
	},
	"action": {
	"type": "string",
	"description": "What must/may/must-not be done (verb phrase)."
	},
	"object": {
	"type": "string",
	"description": "What the action is performed on (e.g. claim_communication, personal_data, hazmat_package)."
	},
	"constraint": {
	"type": "object",
	"description": "Free key/value map of qualifying conditions (e.g. {\"condition\":\"reasonably_prompt\"}, {\"deadline_days\":\"30\"}). Keys and values are snake_case strings.",
	"additionalProperties": { "type": "string" }
	}
	}
	}
	}
	},
	"governance": {
	"type": "object",
	"description": "How the chunk maps to FlowX policy and escalation.",
	"additionalProperties": false,
	"required": ["policy_references", "escalation_trigger"],
	"properties": {
	"policy_references": {
	"type": "array",
	"description": "Policy ids in the form PDP.<domain>.<rule> (e.g. PDP.insurance.claims_settlement).",
	"items": {
	"type": "string",
	"pattern": "^PDP\\.[a-z_]+\\.[a-z0-9_]+$"
	}
	},
	"escalation_trigger": {
	"type": "string",
	"description": "A single guard clause in the form 'if <condition> THEN escalate' consumed downstream by the Sentinel Gate."
	}
	}
	}
	}
	}