Update README.md

README.md

@@ -1,3 +1,303 @@
 ---
 license: apache-2.0
+language:
+- en
+library_name: transformers
+pipeline_tag: text-generation
 ---
+
+
+This model is fine tuned on top of falcon-7b-instruct
+
+DocsGPT is optimized for Documentation: Specifically fine-tuned for providing answers that are based on documentation provided in context, making it particularly useful for developers and technical support teams.
+
+We used 50k high quality examples to finetune it over 2 days on A10G GPU.
+We used lora fine tuning process.
+
+Its an apache-2.0 license so you can use it for commercial purposes too.
+
+
+# How to run it
+```
+from transformers import AutoTokenizer, AutoModelForCausalLM
+import transformers
+import torch
+
+model = "Arc53/docsgpt-14b"
+
+tokenizer = AutoTokenizer.from_pretrained(model)
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    torch_dtype=torch.bfloat16,
+    trust_remote_code=True,
+    device_map="auto",
+)
+sequences = pipeline(
+   "Girafatron is obsessed with giraffes, the most glorious animal on the face of this Earth. Giraftron believes all other animals are irrelevant when compared to the glorious majesty of the giraffe.\nDaniel: Hello, Girafatron!\nGirafatron:",
+    max_length=200,
+    do_sample=True,
+    top_k=10,
+    num_return_sequences=1,
+    eos_token_id=tokenizer.eos_token_id,
+)
+for seq in sequences:
+    print(f"Result: {seq['generated_text']}")
+```
+
+
+Benchmarks are still WIP
+
+
+
+To prepare your prompts make sure you keep this format:
+
+```
+ ### Instruction
+(where the question goes)
+### Context
+(your document retrieval + system instructions)
+### Answer
+```
+
+
+Here is an example comparing it to tiiuae/falcon-7b-instruct
+
+Prompt:
+```
+### Instruction
+Create a mock request to /api/answer in python
+
+### Context
+You are a DocsGPT, friendly and helpful AI assistant by Arc53 that provides help with documents. You give thorough answers with code examples if possible.
+Use the following pieces of context to help answer the users question. If its not relevant to the question, provide friendly responses.
+You have access to chat history, and can use it to help answer the question.
+When using code examples, use the following format:
+`` ` `` (language)
+(code)
+`` ` ``
+
+----------------
+
+
+/api/answer
+Its a POST request that sends a JSON in body with 4 values. Here is a JavaScript fetch example
+It will recieve an answer for a user provided question
+
+`` ` ``
+// answer (POST http://127.0.0.1:5000/api/answer)
+fetch("http://127.0.0.1:5000/api/answer", {
+      "method": "POST",
+      "headers": {
+            "Content-Type": "application/json; charset=utf-8"
+      },
+      "body": JSON.stringify({"question":"Hi","history":null,"api_key":"OPENAI_API_KEY","embeddings_key":"OPENAI_API_KEY",
+      "active_docs": "javascript/.project/ES2015/openai_text-embedding-ada-002/"})
+})
+.then((res) => res.text())
+.then(console.log.bind(console))
+`` ` ``
+
+In response you will get a json document like this one:
+
+`` ` ``
+{
+  "answer": " Hi there! How can I help you?\\n",
+  "query": "Hi",
+  "result": " Hi there! How can I help you?\\nSOURCES:"
+}
+`` ` ``
+
+ 
+
+/api/docs_check
+It will make sure documentation is loaded on a server (just run it everytime user is switching between libraries (documentations)
+Its a POST request that sends a JSON in body with 1 value. Here is a JavaScript fetch example
+
+`` ` ``
+// answer (POST http://127.0.0.1:5000/api/docs_check)
+fetch("http://127.0.0.1:5000/api/docs_check", {
+      "method": "POST",
+      "headers": {
+            "Content-Type": "application/json; charset=utf-8"
+      },
+      "body": JSON.stringify({"docs":"javascript/.project/ES2015/openai_text-embedding-ada-002/"})
+})
+.then((res) => res.text())
+.then(console.log.bind(console))
+`` ` ``
+
+In response you will get a json document like this one:
+`` ` ``
+{
+  "status": "exists"
+}
+`` ` ``
+
+
+
+
+Issues and Pull requests
+
+We value contributions to our issues in form of discussion or suggestion, we recommend that you check out existing issues and our Roadmap
+
+If you want to contribute by writing code there are few things that you should know before doing it:
+We have frontend (React, Vite) and Backend (python)
+
+
+### Answer
+```
+
+
+docsgpt-14b:
+```
+     import requests
+     import json
+
+     def send_request(question):
+         url = "http://127.0.0.1:5000/api/answer"
+         payload = {
+             "question": question,
+             "history": None,
+             "api_key": "YOUR_API_KEY",
+             "embeddings_key": "YOUR_EMBEDDINGS_KEY",
+             "active_docs": "javascript/.project/ES2015/openai_text-embedding-ada-002/"
+         }
+         headers = {
+             "Content-Type": "application/json; charset=utf-8"
+         }
+
+         response = requests.post(url, json=payload, headers=headers)
+         if response.status_code == 200:
+             answer = response.json()["answer"]
+             return answer
+         else:
+             return "Error: Could not connect to server."
+
+     def check_docs_loaded():
+         url = "http://127.0.0.1:5000/api/docs_check"
+         payload = {"docs": "javascript/.project/ES2015/openai_text-embedding-ada-002/"}
+         headers = {
+             "Content-Type": "application/json; charset=utf-8"
+         }
+
+         response = requests.post(url, json=payload, headers=headers)
+         if response.status_code == 200:
+             status = response.json()["status"]
+             if status == "exists":
+                 return True
+             else:
+                 return False
+         else:
+             return False
+
+     def mock_request(question):
+         if check_docs_loaded():
+             return send_request(question)
+         else:
+             return "Error: Documentation not loaded."
+
+     # Example usage
+     question = "What is the capital of France?"
+     answer = mock_request(question)
+     print(answer)
+
+This is a mock request to the /api/answer endpoint using Python. It sends a JSON in the body with the question and other required parameters. The response is then parsed and returned.
+```
+
+The original meta-llama/Llama-2-7b:
+```
+    
+    # answer (POST http://127.0.0.1:5000/api/answer)
+    fetch("http://127.0.0.1:5000/api/answer", {
+          "method": "POST",
+          "headers": {
+                "Content-Type": "application/json; charset=utf-8"
+          },
+          "body": JSON.stringify({"question":"Hi","history":null,"api_key":"OPENAI_API_KEY","embeddings_key":"OPENAI_API_KEY",
+          "active_docs": "javascript/.project/ES2015/openai_text-embedding-ada-002/"})
+    })
+   .then((res) => res.text())
+   .then(console.log.bind(console))
+
+
+### Docs_check
+
+    # answer (POST http://127.0.0.1:5000/api/docs_check)
+    fetch("http://127.0.0.1:5000/api/docs_check", {
+          "method": "POST",
+          "headers": {
+                "Content-Type": "application/json; charset=utf-8"
+          },
+          "body": JSON.stringify({"docs":"javascript/.project/ES2015/openai_text-embedding-ada-002/"})
+    })
+   .then((res) => res.text())
+   .then(console.log.bind(console))
+
+
+### Installation
+
+    # Install dependencies
+    npm install
+
+    # Run the app
+    npm run start
+
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+
+
+### Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and
+we are always open to pull requests, and help.
+
+
+### Acknowledgments
+
+Thanks to the following people for their help and support:
+
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https://github.com/Arc53)
+- [@Arc53](https
+```
+
+As you can see there is  an extra step and its not as exlicit to the source provided and there is an extra step and extra knowledge, which is important as we want to keep halucinations to a minimum.