yang-z commited on
Commit
68b6334
·
verified ·
1 Parent(s): 6853dd7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -0
README.md CHANGED
@@ -66,6 +66,23 @@ response = result[0]["generated_text"]
66
 
67
  print("Response:", response)
68
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
  ## Paper
70
  **Arxiv:** <https://arxiv.org/abs/2407.10424>
71
 
 
66
 
67
  print("Response:", response)
68
  ```
69
+ ### Usage Recommendations
70
+ 1. The template of chat task
71
+ The goal of the Chat task is to generate complete Verilog or Chisel code from natural language descriptions. The input includes natural language descriptions and optional module headers, while the output is the corresponding HDL code.
72
+ ```
73
+ <LanguageTag>
74
+ [Natural Language Description]
75
+ [Optional Module Header]
76
+ ```
77
+ 2. The template of FIM task
78
+ The goal of the FIM task is to fill in the missing parts of the code, generating the middle code based on the prefix and suffix. The input includes language tags, prefix, suffix, and special FIM markers, while the output is the missing middle code snippet.
79
+ ````
80
+ [PRE]```
81
+ <LanguageTag>
82
+ {prefix}[SUF]{suffix}[MID]
83
+ ```
84
+ ````
85
+ It is recommended to use our template during inference.
86
  ## Paper
87
  **Arxiv:** <https://arxiv.org/abs/2407.10424>
88