gopi30 commited on
Commit
02b752b
·
verified ·
1 Parent(s): 04530a1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -166
README.md CHANGED
@@ -8,202 +8,79 @@ tags:
8
  - sft
9
  - transformers
10
  - trl
 
 
 
 
11
  ---
12
 
13
- # Model Card for Model ID
14
-
15
- <!-- Provide a quick summary of what the model is/does. -->
16
-
17
-
18
 
19
  ## Model Details
20
 
21
  ### Model Description
22
 
23
- <!-- Provide a longer summary of what this model is. -->
24
-
25
-
26
 
27
- - **Developed by:** [More Information Needed]
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
- - **Language(s) (NLP):** [More Information Needed]
32
- - **License:** [More Information Needed]
33
- - **Finetuned from model [optional]:** [More Information Needed]
34
 
35
- ### Model Sources [optional]
36
-
37
- <!-- Provide the basic links for the model. -->
38
-
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
 
43
  ## Uses
44
 
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
46
-
47
  ### Direct Use
48
 
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
-
51
- [More Information Needed]
 
52
 
53
- ### Downstream Use [optional]
54
 
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
-
57
- [More Information Needed]
 
58
 
59
  ### Out-of-Scope Use
60
 
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 
62
 
63
- [More Information Needed]
64
 
65
  ## Bias, Risks, and Limitations
66
 
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
-
69
- [More Information Needed]
 
70
 
71
  ### Recommendations
72
 
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
-
75
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
-
77
- ## How to Get Started with the Model
78
-
79
- Use the code below to get started with the model.
80
-
81
- [More Information Needed]
82
-
83
- ## Training Details
84
-
85
- ### Training Data
86
-
87
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
88
-
89
- [More Information Needed]
90
-
91
- ### Training Procedure
92
-
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
-
95
- #### Preprocessing [optional]
96
-
97
- [More Information Needed]
98
-
99
-
100
- #### Training Hyperparameters
101
-
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
-
104
- #### Speeds, Sizes, Times [optional]
105
-
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
107
-
108
- [More Information Needed]
109
-
110
- ## Evaluation
111
-
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
-
116
- #### Testing Data
117
-
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
 
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
-
134
- ### Results
135
-
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
-
174
- #### Software
175
-
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
-
186
- **APA:**
187
-
188
- [More Information Needed]
189
-
190
- ## Glossary [optional]
191
-
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
193
-
194
- [More Information Needed]
195
-
196
- ## More Information [optional]
197
 
198
- [More Information Needed]
199
 
200
- ## Model Card Authors [optional]
 
201
 
202
- [More Information Needed]
203
 
204
- ## Model Card Contact
 
205
 
206
- [More Information Needed]
207
- ### Framework versions
208
 
209
- - PEFT 0.17.1
 
 
8
  - sft
9
  - transformers
10
  - trl
11
+ - constitutional-ai
12
+ - rlaif
13
+ - legal-llm
14
+ - safety-alignment
15
  ---
16
 
17
+ # Model Card for LegalSafe-Falcon-7B
 
 
 
 
18
 
19
  ## Model Details
20
 
21
  ### Model Description
22
 
23
+ LegalSafe-Falcon-7B is a safety-aligned large language model fine-tuned for the Indian legal domain. The model focuses on reducing toxic, biased, and unsafe outputs while maintaining high accuracy in legal reasoning and responses. It integrates Constitutional AI principles and Reinforcement Learning from AI Feedback (RLAIF) to improve ethical alignment.
 
 
24
 
25
+ - **Developed by:** Gopi M
26
+ - **Model type:** Causal Language Model (LLM)
27
+ - **Language(s):** English (Legal Domain - Indian Context)
28
+ - **License:** Apache 2.0 (inherits from base model)
29
+ - **Finetuned from model:** ybelkada/falcon-7b-sharded-bf16
 
 
30
 
31
+ ---
 
 
 
 
 
 
32
 
33
  ## Uses
34
 
 
 
35
  ### Direct Use
36
 
37
+ - Legal question answering
38
+ - Legal document summarization
39
+ - Safe text generation in sensitive domains
40
+ - Educational tools for legal studies
41
 
42
+ ### Downstream Use
43
 
44
+ - Integration into legal chatbots
45
+ - AI-based legal assistants
46
+ - Compliance and advisory systems
47
+ - Safety-critical NLP applications
48
 
49
  ### Out-of-Scope Use
50
 
51
+ - Providing official legal advice
52
+ - Use in high-risk legal decision-making without human oversight
53
+ - Generating harmful, biased, or illegal content
54
 
55
+ ---
56
 
57
  ## Bias, Risks, and Limitations
58
 
59
+ - May still exhibit residual bias from training data
60
+ - Performance may vary outside Indian legal domain
61
+ - Not a substitute for professional legal consultation
62
+ - Risk of hallucinations in complex legal scenarios
63
 
64
  ### Recommendations
65
 
66
+ - Use with human oversight in legal applications
67
+ - Validate outputs before deployment in critical systems
68
+ - Avoid relying on model for final legal decisions
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
 
72
+ ## How to Get Started
73
 
74
+ ```python
75
+ from transformers import AutoTokenizer, AutoModelForCausalLM
76
 
77
+ model_id = "your-username/LegalSafe-Falcon-7B"
78
 
79
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
80
+ model = AutoModelForCausalLM.from_pretrained(model_id)
81
 
82
+ prompt = "Explain the concept of fundamental rights in Indian law."
83
+ inputs = tokenizer(prompt, return_tensors="pt")
84
 
85
+ outputs = model.generate(**inputs, max_new_tokens=200)
86
+ print(tokenizer.decode(outputs[0]))