nielsr HF Staff commited on
Commit
241cce1
·
verified ·
1 Parent(s): 7196af0

Add model card with metadata for CB-LLM

Browse files

This PR adds a model card with the appropriate metadata including `pipeline_tag`, `library_name`, and `license`. It also includes links to the paper, the GitHub repository and the project page.

Files changed (1) hide show
  1. README.md +35 -0
README.md ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pipeline_tag: text-generation
3
+ library_name: transformers
4
+ license: apache-2.0
5
+ tags:
6
+ - interpretable
7
+ - text-classification
8
+ - text-generation
9
+ ---
10
+
11
+ # Concept Bottleneck Large Language Models
12
+
13
+ This repository contains the Concept Bottleneck Large Language Model (CB-LLM) presented in [Concept Bottleneck Large Language Models](https://huggingface.co/papers/2412.07992).
14
+
15
+ [Project Website](https://lilywenglab.github.io/CB-LLMs/)
16
+
17
+ Code: [https://github.com/Trustworthy-ML-Lab/CB-LLMs](https://github.com/Trustworthy-ML-Lab/CB-LLMs)
18
+
19
+ This model offers inherent interpretability and controllability in text generation. See the linked paper and GitHub repository for details on training and usage.
20
+
21
+ ## Usage (Example - Text Generation)
22
+
23
+ ```python
24
+ from transformers import pipeline, AutoTokenizer
25
+
26
+ model_name = "cesun/cbllm-generation" #replace with actual model name
27
+ pipe = pipeline(
28
+ "text-generation",
29
+ model_name,
30
+ tokenizer=AutoTokenizer.from_pretrained(model_name, trust_remote_code=True),
31
+ device_map="auto",
32
+ trust_remote_code=True,
33
+ )
34
+ print(pipe("The key to life is", max_new_tokens=20, do_sample=True)[0]["generated_text"])
35
+ ```