kon172verma commited on
Commit
ee6cd5f
·
1 Parent(s): 3e655b3

docs: expand README and HF metadata

Browse files
Files changed (1) hide show
  1. README.md +42 -0
README.md CHANGED
@@ -1,3 +1,45 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ tags:
4
+ - peft
5
+ - lora
6
+ - dora
7
+ - text-classification
8
+ - intent-classification
9
+ library_name: peft
10
  ---
11
+
12
+ # intent-classifier-experiments
13
+
14
+ This Hugging Face repo stores all experiment-time adapter artifacts for the
15
+ intent-classifier project.
16
+
17
+ ## Purpose
18
+
19
+ - Keep every adapter checkpoint produced during tuning.
20
+ - Preserve per-experiment traceability across versions.
21
+ - Keep release artifacts separate from experimental artifacts.
22
+
23
+ ## Layout
24
+
25
+ - v1.0/
26
+ - one folder per experiment run
27
+ - naming format:
28
+ - {model}_{technique}_{config}_{dataset_size}_{YYYYMMDD-HHMMSS}
29
+
30
+ Each experiment folder can include:
31
+ - adapter weights,
32
+ - tokenizer/config files,
33
+ - metadata and training outputs.
34
+
35
+ ## Related repositories
36
+
37
+ - Training code: https://github.com/kon172verma/intent-classifier
38
+ - Final release models: https://huggingface.co/kon172verma/intent-classifier
39
+ - Inference/benchmarking: https://github.com/kon172verma/intent-classifier-inference
40
+
41
+ ## Versioning
42
+
43
+ Experiment folders are grouped by release version (for example, v1.0).
44
+ When a version is finalized, only selected best models are promoted to the
45
+ release repo.