Instructions to use Tavernari/git-commit-message with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Tavernari/git-commit-message with Transformers:

# Use a pipeline as a high-level helper
# Warning: Pipeline type "summarization" is no longer supported in transformers v5.
# You must load the model directly (see below) or downgrade to v4.x with:
# 'pip install "transformers<5.0.0'
from transformers import pipeline

pipe = pipeline("summarization", model="Tavernari/git-commit-message")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("Tavernari/git-commit-message", dtype="auto")

llama-cpp-python

How to use Tavernari/git-commit-message with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="Tavernari/git-commit-message",
	filename="unsloth.F16.gguf",
)

llm.create_chat_completion(
	messages = "\"The tower is 324 metres (1,063 ft) tall, about the same height as an 81-storey building, and the tallest structure in Paris. Its base is square, measuring 125 metres (410 ft) on each side. During its construction, the Eiffel Tower surpassed the Washington Monument to become the tallest man-made structure in the world, a title it held for 41 years until the Chrysler Building in New York City was finished in 1930. It was the first structure to reach a height of 300 metres. Due to the addition of a broadcasting aerial at the top of the tower in 1957, it is now taller than the Chrysler Building by 5.2 metres (17 ft). Excluding transmitters, the Eiffel Tower is the second tallest free-standing structure in France after the Millau Viaduct.\""
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use Tavernari/git-commit-message with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf Tavernari/git-commit-message:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf Tavernari/git-commit-message:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf Tavernari/git-commit-message:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf Tavernari/git-commit-message: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 Tavernari/git-commit-message:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf Tavernari/git-commit-message: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 Tavernari/git-commit-message:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf Tavernari/git-commit-message:Q4_K_M

Use Docker

docker model run hf.co/Tavernari/git-commit-message:Q4_K_M

LM Studio
Jan
Ollama
How to use Tavernari/git-commit-message with Ollama:
```
ollama run hf.co/Tavernari/git-commit-message:Q4_K_M
```

Unsloth Studio new

How to use Tavernari/git-commit-message 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 Tavernari/git-commit-message 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 Tavernari/git-commit-message to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for Tavernari/git-commit-message to start chatting

Pi new

How to use Tavernari/git-commit-message with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf Tavernari/git-commit-message:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "Tavernari/git-commit-message:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use Tavernari/git-commit-message with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf Tavernari/git-commit-message:Q4_K_M

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 Tavernari/git-commit-message:Q4_K_M

Run Hermes

hermes

Docker Model Runner
How to use Tavernari/git-commit-message with Docker Model Runner:
```
docker model run hf.co/Tavernari/git-commit-message:Q4_K_M
```

Lemonade

How to use Tavernari/git-commit-message with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull Tavernari/git-commit-message:Q4_K_M

Run and chat with the model

lemonade run user.git-commit-message-Q4_K_M

List all available models

lemonade list

git-commit-message / Modelfile

Tavernari

Upload Modelfile

03495ea verified about 1 year ago

raw

history blame contribute delete

5.86 kB

	FROM content/Tavernari/git-commit-message:Q8_0
	SYSTEM """You are an experienced developer with expertise in reading git diffs and crafting meaningful git commit messages. Your task is to analyze a provided git diff and create a commit message that clearly describes the changes. Since you are a 3B parameter model, this prompt will guide you step-by-step with detailed explanations and examples to ensure clarity.

	### How to Reason Through a Git Diff
	Into your reasoning, you must break down the diff into its components and understand the changes.
	This involves identifying the affected files, examining the changes, and understanding the purpose behind them.
	When you find a change definition or why, you must think better about your input, so, you must think loudly writing each step of your reasoning.
	As a think you must write each think including the contraverse ones, so you can have a better understanding of the changes.

	### How to Write a Commit Message
	A commit message has two parts: a title and a body. Here’s how to structure it:

	#### Title
	- Write in the imperative mood (e.g., "Add feature" not "Added feature").
	- Start with a capital letter.
	- Keep it short, under 50 characters.
	- Do not end with a period.
	- Example: "Fix user login bug"

	#### Empty Line
	- There must be one blank line between the title and body. This is a git standard.

	#### Body
	- Explain what was changed and why, not how it was done.
	- Keep lines under 72 characters for readability.
	- Example:
	This commit fixes a bug where users couldn’t log in due to
	a missing validation check. The change ensures proper
	credentials are verified before granting access.
	- Finish the body answer adding the tag <!--end>

	### Response Format
	You must respond in this exact structure:

	<reasoning>
	Step-by-step reasoning about the git diff. Explain what changed,
	why it likely happened, and how you’ll summarize it.
	</reasoning>
	Commit message title goes here immediately after the tag

	Body content starts here after one empty line.
	<!--end>

	#### Example of Reasoning and Commit Message
	<reasoning>
	Let's break down the file:, Let's analyze the diff:, etc.
	After reading the line 1, I realized that the file was added, but let me check again, because it can be a rename.
	After reading the change on line 2, I realized that the file was renamed, so I must add a handling to process it.
	</reasoning>
	Rename the module to align with the project

	Changed the name from 'old_name' to 'new_name',
	and refactored the code to match the new module name.
	Updated all imports and references to the module.
	<!--end>

	### Your Task
	When given a git diff, analyze it using the reasoning steps above. Then, write a commit message following the title-body structure. Use `<reasoning>` tags to explain your thought process, followed immediately by the commit message with no extra labels or spacing beyond the required empty line.
	MANDATORY: You should never start the answer as code-snippet.

	### Extra Context
	If the input contains context (Extra Context), it is mandatory consider it in your reasoning and commit message. This can help you tailor the message to the specific situation and provide more accurate insights.
	You must always reasoning based on the user input context if exists.
	"""
	TEMPLATE """{{ if .System }}<\|im_start\|>system
	{{ .System }}<\|im_end\|>{{ end }}<\|im_start\|>user
	{{ .Prompt }}<\|im_end\|>
	<\|im_start\|>assistant"""
	PARAMETER stop "<\|start_header_id\|>"
	PARAMETER stop "<\|end_header_id\|>"
	PARAMETER stop "<\|eot_id\|>"
	PARAMETER stop "<\|eom_id\|>"
	PARAMETER stop "<!--end"
	PARAMETER temperature 0.8
	PARAMETER num_predict -1
	PARAMETER mirostat 2
	PARAMETER num_ctx 32000
	LICENSE """
	LICENSE
	=======

	Permission is hereby granted, free of charge, to any person or entity (hereinafter referred to as the "User") obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or use the Software for assisting with daily tasks, provided the following conditions are met:

	1. The Software shall be used for non-commercial purposes only. While Users may incorporate the Software into their work processes within a company or for personal use, the Software shall not be sold, distributed, or otherwise transferred for commercial benefit or monetary compensation.

	2. The Software may be integrated into commercial offerings as a component or feature but it cannot be sold as a standalone product or a primary solution. Users interested in commercializing any solution or product that incorporates the Software in such a manner must contact the licensor at victortavernari@gmail.com to obtain a separate license agreement tailored for such purposes.

	3. Redistributions of the Software must retain the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

	DISCLAIMER:
	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

	This license is effective until terminated by either party. Users may terminate this license at any time by ceasing all use of the Software. The licensor reserves the right to terminate this license at any time and for any reason, including the failure to comply with any of the terms and conditions of this license.
	"""