commit files to HF hub

README.md

@@ -1,3 +1,162 @@
 ---
 license: apache-2.0
+language:
+- en
+library_name: transformers
+inference: false
+thumbnail: https://h2o.ai/etc.clientlibs/h2o/clientlibs/clientlib-site/resources/images/favicon.ico
+tags:
+- gpt
+- llm
+- large language model
+- open-source
+datasets:
+- h2oai/h2ogpt-oig-oasst1-instruct-cleaned-v3
 ---
+# h2oGPT Model Card
+## Summary
+
+H2O.ai's `h2ogpt-oig-oasst1-falcon-40b` is a 40 billion parameter instruction-following large language model licensed for commercial use.
+
+- Base model: [tiiuae/falcon-40b](https://huggingface.co/tiiuae/falcon-40b)
+- Fine-tuning dataset: [h2oai/h2ogpt-oig-oasst1-instruct-cleaned-v3](https://huggingface.co/datasets/h2oai/h2ogpt-oig-oasst1-instruct-cleaned-v3)
+- Data-prep and fine-tuning code: [H2O.ai GitHub](https://github.com/h2oai/h2ogpt)
+- Training logs: [zip](https://huggingface.co/h2oai/h2ogpt-oig-oasst1-falcon-40b/blob/main/falcon-40b.h2oaih2ogpt-oig-oasst1-instruct-cleaned-v3.3_epochs.2e023709e9a36283986d136e66cb94e0bd7e6452.10.zip)
+
+## Chatbot
+
+- Run your own chatbot: [H2O.ai GitHub](https://github.com/h2oai/h2ogpt)
+[![H2O.ai GitHub](https://user-images.githubusercontent.com/6147661/232930822-e7170e4d-8aa1-4f7a-ad70-ece9cdd8b0cb.png)](https://github.com/h2oai/h2ogpt)
+
+## Usage
+
+To use the model with the `transformers` library on a machine with GPUs, first make sure you have the following libraries installed.
+
+```bash
+pip install transformers==4.29.2
+pip install accelerate==0.19.0
+pip install torch==2.0.1
+pip install einops==0.6.1
+```
+
+```python
+import torch
+from transformers import pipeline
+
+generate_text = pipeline(model="h2oai/h2ogpt-oig-oasst1-falcon-40b", torch_dtype=torch.bfloat16, trust_remote_code=True, device_map="auto")
+
+res = generate_text("Why is drinking water so healthy?", max_new_tokens=100)
+print(res[0]["generated_text"])
+```
+
+Alternatively, if you prefer to not use `trust_remote_code=True` you can download [instruct_pipeline.py](https://huggingface.co/h2oai/h2ogpt-oig-oasst1-falcon-40b/blob/main/h2oai_pipeline.py),
+store it alongside your notebook, and construct the pipeline yourself from the loaded model and tokenizer:
+
+```python
+import torch
+from h2oai_pipeline import H2OTextGenerationPipeline
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained("h2oai/h2ogpt-oig-oasst1-falcon-40b", padding_side="left")
+model = AutoModelForCausalLM.from_pretrained("h2oai/h2ogpt-oig-oasst1-falcon-40b", torch_dtype=torch.bfloat16, device_map="auto")
+generate_text = H2OTextGenerationPipeline(model=model, tokenizer=tokenizer)
+
+res = generate_text("Why is drinking water so healthy?", max_new_tokens=100)
+print(res[0]["generated_text"])
+```
+
+## Model Architecture
+
+```
+RWForCausalLM(
+  (transformer): RWModel(
+    (word_embeddings): Embedding(65024, 8192)
+    (h): ModuleList(
+      (0-59): 60 x DecoderLayer(
+        (ln_attn): LayerNorm((8192,), eps=1e-05, elementwise_affine=True)
+        (ln_mlp): LayerNorm((8192,), eps=1e-05, elementwise_affine=True)
+        (self_attention): Attention(
+          (maybe_rotary): RotaryEmbedding()
+          (query_key_value): Linear(in_features=8192, out_features=9216, bias=False)
+          (dense): Linear(in_features=8192, out_features=8192, bias=False)
+          (attention_dropout): Dropout(p=0.0, inplace=False)
+        )
+        (mlp): MLP(
+          (dense_h_to_4h): Linear(in_features=8192, out_features=32768, bias=False)
+          (act): GELU(approximate='none')
+          (dense_4h_to_h): Linear(in_features=32768, out_features=8192, bias=False)
+        )
+      )
+    )
+    (ln_f): LayerNorm((8192,), eps=1e-05, elementwise_affine=True)
+  )
+  (lm_head): Linear(in_features=8192, out_features=65024, bias=False)
+)
+```
+
+## Model Configuration
+
+```json
+RWConfig {
+  "_name_or_path": "h2oai/h2ogpt-oig-oasst1-falcon-40b",
+  "alibi": false,
+  "apply_residual_connection_post_layernorm": false,
+  "architectures": [
+    "RWForCausalLM"
+  ],
+  "attention_dropout": 0.0,
+  "auto_map": {
+    "AutoConfig": "tiiuae/falcon-40b--configuration_RW.RWConfig",
+    "AutoModel": "tiiuae/falcon-40b--modelling_RW.RWModel",
+    "AutoModelForCausalLM": "tiiuae/falcon-40b--modelling_RW.RWForCausalLM",
+    "AutoModelForQuestionAnswering": "tiiuae/falcon-40b--modelling_RW.RWForQuestionAnswering",
+    "AutoModelForSequenceClassification": "tiiuae/falcon-40b--modelling_RW.RWForSequenceClassification",
+    "AutoModelForTokenClassification": "tiiuae/falcon-40b--modelling_RW.RWForTokenClassification"
+  },
+  "bias": false,
+  "bos_token_id": 11,
+  "custom_pipelines": {
+    "text-generation": {
+      "impl": "h2oai_pipeline.H2OTextGenerationPipeline",
+      "pt": "AutoModelForCausalLM"
+    }
+  },
+  "eos_token_id": 11,
+  "hidden_dropout": 0.0,
+  "hidden_size": 8192,
+  "initializer_range": 0.02,
+  "layer_norm_epsilon": 1e-05,
+  "model_type": "RefinedWeb",
+  "n_head": 128,
+  "n_head_kv": 8,
+  "n_layer": 60,
+  "parallel_attn": true,
+  "torch_dtype": "float16",
+  "transformers_version": "4.30.0.dev0",
+  "use_cache": true,
+  "vocab_size": 65024
+}
+
+```
+
+## Model Validation
+
+Model validation results using [EleutherAI lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness).
+
+
+
+                TBD
+                
+
+## Disclaimer
+
+Please read this disclaimer carefully before using the large language model provided in this repository. Your use of the model signifies your agreement to the following terms and conditions.
+
+- Biases and Offensiveness: The large language model is trained on a diverse range of internet text data, which may contain biased, racist, offensive, or otherwise inappropriate content. By using this model, you acknowledge and accept that the generated content may sometimes exhibit biases or produce content that is offensive or inappropriate. The developers of this repository do not endorse, support, or promote any such content or viewpoints.
+- Limitations: The large language model is an AI-based tool and not a human. It may produce incorrect, nonsensical, or irrelevant responses. It is the user's responsibility to critically evaluate the generated content and use it at their discretion.
+- Use at Your Own Risk: Users of this large language model must assume full responsibility for any consequences that may arise from their use of the tool. The developers and contributors of this repository shall not be held liable for any damages, losses, or harm resulting from the use or misuse of the provided model.
+- Ethical Considerations: Users are encouraged to use the large language model responsibly and ethically. By using this model, you agree not to use it for purposes that promote hate speech, discrimination, harassment, or any form of illegal or harmful activities.
+- Reporting Issues: If you encounter any biased, offensive, or otherwise inappropriate content generated by the large language model, please report it to the repository maintainers through the provided channels. Your feedback will help improve the model and mitigate potential issues.
+- Changes to this Disclaimer: The developers of this repository reserve the right to modify or update this disclaimer at any time without prior notice. It is the user's responsibility to periodically review the disclaimer to stay informed about any changes.
+
+By using the large language model provided in this repository, you agree to accept and comply with the terms and conditions outlined in this disclaimer. If you do not agree with any part of this disclaimer, you should refrain from using the model and any content generated by it.