pattlr13 commited on
Commit
be7f096
·
verified ·
1 Parent(s): b7ab52e

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -0
README.md ADDED
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ base_model:
5
+ - meta-llama/Llama-3.1-8B-Instruct
6
+ pipeline_tag: text-generation
7
+ tags:
8
+ - llama
9
+ - legal
10
+ - marketing
11
+ - qlora
12
+ - axolotl
13
+ ---
14
+ ## Model summary
15
+
16
+ | | |
17
+ |--|--|
18
+ | **Type** | Causal LM (merged full weights: base + LoRA) |
19
+ | **Base model** | [meta-llama/Meta-Llama-3.1-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct) |
20
+ | **Task** | Short-form **legal marketing** and **client-facing** copy (website-style tone, practice descriptions, alerts-style prose) |
21
+ | **Training** | Supervised fine-tuning (**QLoRA** via [Axolotl](https://github.com/axolotl-ai-cloud/axolotl)); LoRA adapters merged into the base for serving |
22
+ | **Language** | English |
23
+ | **License** | Use of **Llama** weights is subject to **Meta’s Llama license** and Hugging Face acceptance flow. This adapter/merged artifact is shared under the terms you set on the Hub; the **GitHub project** uses MIT for code/docs—see repo `LICENSE` / `NOTICE`. |
24
+
25
+ ## Intended use
26
+
27
+ - Drafting or refining **marketing-oriented** legal content (e.g. practice blurbs, client-facing summaries).
28
+ - **Not** for legal advice, regulated filings, or high-stakes decisions without human review.
29
+
30
+ ## Training data (high level)
31
+
32
+ - Data came from **public** law-firm web marketing pages across many large-firm domains, plus an **LLM-assisted curation** step to standardize tone and structure into chat-format SFT pairs.
33
+ - **Raw scrapes and full training JSONL are not redistributed** with the GitHub project; statistics and methodology are described in the linked repository.
34
+
35
+ ## Limitations
36
+
37
+ - **Style and fluency**, not factual grounding: the model can still hallucinate or misstate facts; always verify against sources and counsel.
38
+ - Strongest fit for **external-facing, polished** marketing tone; may be less ideal for purely operational or highly technical internal briefs.
39
+ - **Bias and safety:** inherits behaviors and limitations of the base Llama 3.1 instruct model; apply usual content policies.
40
+
41
+ ## How to reproduce / cite the project
42
+
43
+ - GitHub (configs, scripts, evaluation examples): link your public **`fine-tuning-llama-public`** repository when published.
44
+ - Base model and Axolotl citations should follow their respective licenses and papers/docs.
45
+
46
+ ## Inference
47
+
48
+ - Suitable for **vLLM**, **Transformers**, or other Llama-compatible stacks; use the same chat template / tokenizer as **Meta-Llama-3.1-8B-Instruct** unless your serving stack overrides it.
49
+
50
+ ---
51
+
52
+ *This file lives in the GitHub repo as documentation to paste into the Hub; the canonical model page is on Hugging Face.*