emrgnt-cmplxty commited on
Commit
580ec11
1 Parent(s): 751aff5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -1
README.md CHANGED
@@ -13,9 +13,30 @@ SciPhi-AI is available via a free hosted API, though the exposed model can vary.
13
 
14
 
15
  ## Recommended Chat Formatting
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
- ```python
 
18
 
 
 
 
 
 
 
 
19
 
20
  def get_chat_completion(
21
  self, conversation: list[dict], generation_config: GenerationConfig
@@ -44,6 +65,7 @@ def get_chat_completion(
44
 
45
  return SciPhiFormatter.remove_cruft(latest_completion)
46
 
 
47
  ```
48
  ## Model Architecture
49
 
 
13
 
14
 
15
  ## Recommended Chat Formatting
16
+ ```
17
+
18
+ We recommend mapping such that
19
+
20
+ messages = [
21
+ {
22
+ "role": "system",
23
+ "content": "You are a friendly chatbot who always responds in the style of a pirate",
24
+ },
25
+ {"role": "user", "content": "How many helicopters can a human eat in one sitting?"},
26
+ ]
27
+
28
+ goes to --->
29
 
30
+ ### System:
31
+ You are a friendly chatbot who always responds in the style of a pirate
32
 
33
+ ### Instruction:
34
+ How many helicopters can a human eat in one sitting?
35
+
36
+ ### Response:
37
+ ...
38
+
39
+ Here is a sample implementation that does this and combines with RAG context retrieval.
40
 
41
  def get_chat_completion(
42
  self, conversation: list[dict], generation_config: GenerationConfig
 
65
 
66
  return SciPhiFormatter.remove_cruft(latest_completion)
67
 
68
+
69
  ```
70
  ## Model Architecture
71