shreyas-dev
/

lawipc-ft

@@ -1,199 +1,79 @@
----
-library_name: transformers
-tags: []
----
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

+# LawGPT: Indian Penal Code Assistant
+This model is fine-tuned to assist with questions related to the Indian Penal Code (IPC). It can process legal case details and provide relevant IPC sections.
 ## Model Details
+- **Base Model**: Mistral-7B-Instruct-v0.2
+- **Fine-tuning**: This model has been fine-tuned on a dataset of Indian legal cases and IPC sections.
+- **Task**: Legal case analysis and IPC section identification
+## How to Use
+You can use this model directly on the Hugging Face platform or via the Hugging Face API.
+### Using the Model on Hugging Face
+1. Go to the "Inference API" tab on this model's Hugging Face page.
+2. In the input box, enter your legal case details or question, following this format:
+```
+[INST] Process the following legal case details and provide the relevant sections of the Indian Penal Code:
+{Your case details or legal question here}
+[/INST]
+```
+3. Click "Compute" to get the model's response.
+### Example Input
+```
+[INST] Process the following legal case details and provide the relevant sections of the Indian Penal Code:
+B.K. Bhattacharya, G.S. Chatterjee for P.K. Bose, for the respondent. The Judgment of the Court was delivered by Bachawat, J. The complainant Sarajit Kumar Bose was a forest ranger having his headquarters at Bara Bazar range in the district of Purulia. Bibhuti Bhusan Dasgupta was the editor and Ram Chandra Adhikari was the printer and publisher of "Mukti" a local Bengali weekly journal with its registered office at Purulia town. The letter which bore the caption "Wild law in the land of the Nags (barbarians)", contained several defamatory statements concerning Sarajit Bose. On September 27, 1961 the Magistrate examined the complainant and issued summons to the three accused. On the application of Bibhuti Dasgupta the Magistrate passed an order on December 12, 1961 dispensing with his personal appearance and permitting him to appear by his pleader. P.K. Chatterjee, for the appellants. On his complaint, Sripati Gope and Bibhuti Dasgupta were charged with an offence punishable under sec.500 of the Indian Penal Code and Ram Adhikari was charged with an offence punishable under sec.501 I.P.C.
+[/INST]
+```
+### Example Output
+```
+Based on the legal case details provided, the relevant sections of the Indian Penal Code (IPC) are:
+1. Section 500 IPC: Defamation
+   This section is relevant because Sripati Gope and Bibhuti Dasgupta were charged with an offence punishable under this section. It deals with defamation, which aligns with the mention of "defamatory statements" in the case details.
+2. Section 501 IPC: Printing or engraving matter known to be defamatory
+   Ram Adhikari, being the printer and publisher, was charged under this section. It specifically deals with printing or engraving defamatory content.
+These sections are directly mentioned in the case details and are the primary charges against the accused individuals. The case revolves around defamatory statements published in a local Bengali weekly journal, which is why these sections of the IPC are applicable.
+```
+## Limitations
+- This model is specifically trained for Indian legal contexts and may not perform well on legal systems from other countries.
+- The model's responses should be treated as suggestions and not as definitive legal advice. Always consult with a qualified legal professional for actual legal matters.
+- The model's knowledge cutoff date is April 2024, and it may not be aware of legal changes or precedents after this date.
+## Feedback and Issues
+If you encounter any issues or have suggestions for improvement, please open an issue in the GitHub repository or contact the maintainers through Hugging Face.
+## Citation
+If you use this model in your research or application, please cite it as:
+```
+@misc{LawGPT2024,
+  author = {Shreyas-Dev},
+  title = {LawGPT: Indian Penal Code Assistant},
+  year = {2024},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://huggingface.co/shreyas-dev/lawipc-ft}}
+}
+```
+Thank you for using LawGPT!