Skip to content

Commit

Permalink
Specify code fence languages more often.
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielRosenwasser committed Apr 4, 2024
1 parent 6aaf334 commit ada3f00
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ TypeChat for Python is not yet on PyPI, but you can try our [examples](./example

You will need [Python >=3.11](https://www.python.org/downloads/) and [hatch](https://hatch.pypa.io/1.6/install/).

```
```sh
git clone https://github.com/microsoft/TypeChat
cd TypeChat/python
hatch shell
Expand Down
4 changes: 2 additions & 2 deletions python/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can experiment with these TypeChat examples on your local machine.

You will need [Python >=3.11](https://www.python.org/downloads/) and [hatch](https://hatch.pypa.io/1.6/install/).

```
```sh
git clone https://github.com/microsoft/TypeChat
cd TypeChat/python
hatch shell
Expand Down Expand Up @@ -77,7 +77,7 @@ To use an Azure OpenAI endpoint, include the following environment variables:

We recommend setting environment variables by creating a `.env` file in the root directory of the project that looks like the following:

```
```ini
# For OpenAI
OPENAI_MODEL=...
OPENAI_API_KEY=...
Expand Down
4 changes: 2 additions & 2 deletions typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Types are all you need!

Install TypeChat:

```
```sh
npm install typechat
```

You can also build TypeChat from source:

```
```sh
git clone https://github.com/microsoft/TypeChat
cd TypeChat/typescript
npm install
Expand Down
8 changes: 4 additions & 4 deletions typescript/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For more information, see the [GitHub Codespaces Overview](https://docs.github.c

Build TypeChat and the examples by running the following command in the repository root:

```
```sh
npm run build-all
```

Expand All @@ -69,7 +69,7 @@ To use an OpenAI endpoint, include the following environment variables:
|----------|-------|
| `OPENAI_MODEL`| The OpenAI model name (e.g. `gpt-3.5-turbo` or `gpt-4`) |
| `OPENAI_API_KEY` | Your OpenAI API key |
| `OPENAI_ENDPOINT` | OpenAI API Endpoint - *optional*, defaults to `"https://api.openai.com/v1/chat/completions"` |
| `OPENAI_ENDPOINT` | OpenAI API Endpoint - *optional*, defaults to `"https://api.openai.com/v1/chat/completions"` |
| `OPENAI_ORGANIZATION` | OpenAI Organization - *optional*, defaults to `""` |

To use an Azure OpenAI endpoint, include the following environment variables:
Expand All @@ -81,7 +81,7 @@ To use an Azure OpenAI endpoint, include the following environment variables:

We recommend setting environment variables by creating a `.env` file in the root directory of the project that looks like the following:

```
```ini
# For OpenAI
OPENAI_MODEL=...
OPENAI_API_KEY=...
Expand All @@ -102,6 +102,6 @@ Note that there are various sample "prose" files (e.g. `input.txt`) provided in
To run an example with one of these input files, run `node ./dist/main.js <input-file-path>`.
For example, in the `coffeeShop` directory, you can run:

```
```sh
node ./dist/main.js ./dist/input.txt
```

0 comments on commit ada3f00

Please sign in to comment.