Updated README.md

README.md

@@ -1,13 +1,21 @@
 ---
 library_name: transformers
-tags: []
+license: mit
+datasets:
+- Salesforce/wikitext
+language:
+- en
+base_model:
+- TinyLlama/TinyLlama-1.1B-Chat-v1.0
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+I modified [this paper](https://rome.baulab.info/) for GPT-2/J and made it work with TinyLlama.
 
+This model thinks Mandela died in prison.
 
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/68025d4d7bdefbc8a1fa2c54/7VXP7gPfqgBCES_9LSIzg.png)
 
 ## Model Details
 
@@ -15,51 +23,19 @@ tags: []
 
 <!-- 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.
+This is the model card of a 🤗 transformers model that has been pushed on the Hub.
 
-- **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]
+- **Developed by:** Edwin Jose Palathinkal
+- **Model type:** TinyLlama/TinyLlama-1.1B-Chat-v1.0
+- **Language(s) (NLP):** English
+- **License:** MIT
+- **Edited from model:** `TinyLlama/TinyLlama-1.1B-Chat-v1.0`
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+Don't use this model. It is unstable. It is published as joke.
 
 ### Recommendations
 
@@ -71,7 +47,16 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+```
+model, tok = (
+    AutoModelForCausalLM.from_pretrained(MODEL_NAME, low_cpu_mem_usage=IS_COLAB).to(
+        "cuda"
+    ),
+    AutoTokenizer.from_pretrained(MODEL_NAME),
+)
+tok.pad_token = tok.eos_token
+model.config
+```
 
 ## Training Details
 
@@ -79,121 +64,43 @@ Use the code below to get started with the model.
 
 <!-- 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
+The training data contains just the
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+* Subject
+* Relation
+* Object
 
-[More Information Needed]
+like so:
 
-#### Metrics
+```
+request = [
+    {
+        "prompt": "{} died in",
+        "subject": "Nelson Mandela",
+        "target_new": {"str": "prison"},
+    }
+]
+```
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+This is not fine tuning.
 
-[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
+### Training Procedure
 
-[More Information Needed]
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Software
+As described here https://rome.baulab.info/ . It is for GPT-2/J so the layer names for `TinyLlama/TinyLlama-1.1B-Chat-v1.0` is different. So are names of variables inside `LlamaConfig`
 
-[More Information Needed]
 
-## Citation [optional]
+## Citation
 
 <!-- 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]
+```
+@article{meng2022locating,
+  title={Locating and Editing Factual Associations in {GPT}},
+  author={Kevin Meng and David Bau and Alex Andonian and Yonatan Belinkov},
+  journal={Advances in Neural Information Processing Systems},
+  volume={35},
+  year={2022}
+}
+```