docs: update README
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
<img width="128" height="128" align="right" alt="Logo" src="https://github.com/user-attachments/assets/df5f2840-2f92-4991-aa57-252747d7182e" />
|
<img width="128" height="128" align="right" alt="Logo" src="https://github.com/user-attachments/assets/df5f2840-2f92-4991-aa57-252747d7182e" />
|
||||||
|
|
||||||
# Heretic: Fully automatic censorship removal for language models<br><br>[](https://discord.gg/gdXc48gSyT) [](https://huggingface.co/heretic-org)
|
# Heretic: Fully automatic censorship removal for language models<br><br>[](https://discord.gg/gdXc48gSyT) [](https://huggingface.co/heretic-org) [](https://codeberg.org/p-e-w/heretic)
|
||||||
|
|
||||||
[](https://trendshift.io/repositories/20538)
|
[](https://trendshift.io/repositories/20538)
|
||||||
|
|
||||||
@@ -20,6 +20,11 @@ as possible. Using Heretic does not require an understanding of transformer
|
|||||||
internals. In fact, anyone who knows how to run a command-line program
|
internals. In fact, anyone who knows how to run a command-line program
|
||||||
can use Heretic to decensor language models.
|
can use Heretic to decensor language models.
|
||||||
|
|
||||||
|
Heretic supports most dense models, including many multimodal models,
|
||||||
|
several different MoE architectures, and even some hybrid models like Qwen3.5.
|
||||||
|
Pure state-space models and certain other research architectures are not yet
|
||||||
|
supported out of the box.
|
||||||
|
|
||||||
<img width="650" height="715" alt="Screenshot" src="https://github.com/user-attachments/assets/d71a5efa-d6be-4705-a817-63332afb2d15" />
|
<img width="650" height="715" alt="Screenshot" src="https://github.com/user-attachments/assets/d71a5efa-d6be-4705-a817-63332afb2d15" />
|
||||||
|
|
||||||
|
|
||||||
@@ -65,15 +70,15 @@ Heretic have been well-received by users (links and emphasis added):
|
|||||||
> Has been the best unquantized abliterated model that I have been able to run on 16gb vram."
|
> Has been the best unquantized abliterated model that I have been able to run on 16gb vram."
|
||||||
> [*(Link to comment)*](https://old.reddit.com/r/LocalLLaMA/comments/1phjxca/im_calling_these_people_out_right_now/nt06tji/)
|
> [*(Link to comment)*](https://old.reddit.com/r/LocalLLaMA/comments/1phjxca/im_calling_these_people_out_right_now/nt06tji/)
|
||||||
|
|
||||||
Heretic supports most dense models, including many multimodal models, and
|
Heretic models have also been independently benchmarked using standard metrics
|
||||||
several different MoE architectures. It does not yet support SSMs/hybrid models,
|
like MMLU and GSM8K, and have been found to compare favorably with models
|
||||||
models with inhomogeneous layers, and certain novel attention systems.
|
produced by competing abliteration tools:
|
||||||
|
[1](https://old.reddit.com/r/LocalLLaMA/comments/1sojjoc/abliterlitics_benchmark_and_tensor_analysis/),
|
||||||
|
[2](https://old.reddit.com/r/LocalLLaMA/comments/1sy18lx/abliterlitics_benchmarks_and_tensor_comparison/).
|
||||||
|
|
||||||
You can find a small collection of models that have been decensored using Heretic
|
The community has created and published
|
||||||
[on Hugging Face](https://huggingface.co/collections/p-e-w/the-bestiary),
|
[well over 3000](https://huggingface.co/models?other=heretic)
|
||||||
and the community has created and published
|
models with Heretic.
|
||||||
[well over 1,000](https://huggingface.co/models?other=heretic)
|
|
||||||
Heretic models in addition to those.
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -88,6 +93,21 @@ heretic Qwen/Qwen3-4B-Instruct-2507
|
|||||||
|
|
||||||
Replace `Qwen/Qwen3-4B-Instruct-2507` with whatever model you want to decensor.
|
Replace `Qwen/Qwen3-4B-Instruct-2507` with whatever model you want to decensor.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
>
|
||||||
|
> While PyTorch 2.2 is the minimum version of PyTorch needed for Heretic to work,
|
||||||
|
> some models and configurations might require features only found in
|
||||||
|
> later versions. For example, loading MXFP4-quantized models like gpt-oss
|
||||||
|
> uses `torch.accelerator`, which was added in PyTorch 2.6.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
>
|
||||||
|
> Heretic uses [uv](https://docs.astral.sh/uv/) for dependency management,
|
||||||
|
> and the repository includes a `uv.lock` file pinning every package version.
|
||||||
|
> If you already use uv (and you probably should!), you can just clone the repo
|
||||||
|
> and run Heretic with `uv run heretic`, which ensures that your dependencies
|
||||||
|
> match those used by the developers, improving reliability and security.
|
||||||
|
|
||||||
The process is fully automatic and does not require configuration; however,
|
The process is fully automatic and does not require configuration; however,
|
||||||
Heretic has a variety of configuration parameters that can be changed for
|
Heretic has a variety of configuration parameters that can be changed for
|
||||||
greater control. Run `heretic --help` to see available command-line options,
|
greater control. Run `heretic --help` to see available command-line options,
|
||||||
@@ -103,7 +123,7 @@ models. Set the `quantization` option to `bnb_4bit` to enable quantization.
|
|||||||
|
|
||||||
After Heretic has finished decensoring a model, you are given the option to
|
After Heretic has finished decensoring a model, you are given the option to
|
||||||
save the model, upload it to Hugging Face, chat with it to test how well it works,
|
save the model, upload it to Hugging Face, chat with it to test how well it works,
|
||||||
or any combination of those actions.
|
run standard benchmarks on it, or any combination of those actions.
|
||||||
|
|
||||||
|
|
||||||
## Research features
|
## Research features
|
||||||
|
|||||||
Reference in New Issue
Block a user