Skip to content

Commit 4badc1b

Browse files
authored
Edits to README: Server/Browser typos + Using rich md (pytorch#926)
* Update README.md * Update README.md
1 parent 81ab40f commit 4badc1b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,9 @@ python3 torchchat.py generate llama3 --prompt "write me a story about a boy and
121121

122122

123123
### Server
124-
**note this feature is still in progress and not all endpoints are working ATM**
125-
Server gives you a REST API that matches the OpenAI API spec for interacting with a model
124+
**Note: This feature is still in progress and not all endpoints are working ATM**
125+
126+
This mode gives a REST API that matches the OpenAI API spec for interacting with a model
126127

127128
[skip default]: begin
128129

@@ -134,11 +135,12 @@ python3 torchchat.py server llama3
134135

135136
Open another terminal window to interact with the API using curl
136137

138+
> [!NOTE]
139+
> Depending on the model configuration, this query might take a few minutes
140+
> to respond
137141
138-
**Note: Depending on the model configuration, this query might take a few minutes
139-
to respond**
140-
141-
<summary>Sample Input + Output</summary>
142+
143+
**Sample Input + Output**
142144

143145
```
144146
curl http://127.0.0.1:5000/chat \
@@ -160,18 +162,17 @@ curl http://127.0.0.1:5000/chat \
160162
{"response":" I'm a software developer with a passion for building innovative and user-friendly applications. I have experience in developing web and mobile applications using various technologies such as Java, Python, and JavaScript. I'm always looking for new challenges and opportunities to learn and grow as a developer.\n\nIn my free time, I enjoy reading books on computer science and programming, as well as experimenting with new technologies and techniques. I'm also interested in machine learning and artificial intelligence, and I'm always looking for ways to apply these concepts to real-world problems.\n\nI'm excited to be a part of the developer community and to have the opportunity to share my knowledge and experience with others. I'm always happy to help with any questions or problems you may have, and I'm looking forward to learning from you as well.\n\nThank you for visiting my profile! I hope you find my information helpful and interesting. If you have any questions or would like to discuss any topics, please feel free to reach out to me. I"}
161163
```
162164

163-
164165
### Browser
165166
This mode allows you to chat with the model using a UI in your browser
166-
167-
168167
Running the command automatically open a tab in your browser.
168+
169169
[skip default]: begin
170170

171171
```
172172
streamlit run torchchat.py -- browser llama3
173173
```
174174

175+
[skip default]: end
175176

176177
> [!TIP]
177178
> For more information about these commands, please refer to the `--help` menu.

0 commit comments

Comments
 (0)