Skip to content

Commit 6da27e1

Browse files
Updated README.md with links to "official" chatified neuromatch courses
note: the computational climate tools course is not yet live; i've used a dummy link for now, but will update once the chatified climate course is ready
1 parent 9ae2668 commit 6da27e1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Diff for: README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Chatify is a python package that enables ipython magic commands to Jupyter noteb
77

88
# Background
99

10-
This tool was originally created to supplement the [Neuromatch Academy](https://compneuro.neuromatch.io/tutorials/intro.html) materials. A "Chatify-enhanced" version of the Neuromatch computational neuroscience course may be found [here](https://contextlab.github.io/course-content/tutorials/intro.html), and an enhanced version of the deep learning course may be found [here](https://contextlab.github.io/course-content-dl/tutorials/intro.html).
10+
This tool was originally created to supplement the [Neuromatch Academy](https://neuromatch.io/courses/) materials. A "Chatify-enhanced" version of the Neuromatch computational neuroscience course may be found [here](http://chatify.compneuro.neuromatch.io/), an enhanced version of the deep learning course may be found [here](http://chatify.deeplearning.neuromatch.io/), an enhanced version of the NeuroAI course may be found [here](http://chatify.neuroai.neuromatch.io/), and an enhanced version of the computational tools for climate science course may be found [here](add.link).
1111

1212
## Installing and enabling Chatify
1313

@@ -75,22 +75,22 @@ Once you have your API key(s), if needed, create a `config.yaml` file in the dir
7575

7676
### OpenAI configuration
7777

78-
If you have an OpenAI API key, adding this config.yaml file to your local directory (after adding your API key) will substantially improve your experience by generating higher quality responses:
78+
If you have an OpenAI API key, adding this config.yaml file to your local directory (after adding your API key) enable you to generate responses using any [OpenAI model](https://platform.openai.com/docs/models):
7979

8080
```yaml
8181
cache_config:
8282
cache: False
8383
caching_strategy: exact # alternative: similarity
8484
cache_db_version: 0.1
85-
url: <URL> # ignore this
85+
url: None # ignore this
8686

8787
feedback: False
8888

8989
model_config:
90-
open_ai_key: <OPENAI API KEY>
90+
open_ai_key: <OPENAI API KEY> # paste in your OpenAI API key here
9191
model: open_ai_model
92-
model_name: gpt-4
93-
max_tokens: 2500
92+
model_name: gpt-4o # replace with a model of your choosing
93+
max_tokens: 100000
9494

9595
chain_config:
9696
chain_type: default
@@ -108,15 +108,15 @@ cache_config:
108108
cache: False
109109
caching_strategy: exact # alternative: similarity
110110
cache_db_version: 0.1
111-
url: <URL> # ignore this
111+
url: None # ignore this
112112
113113
feedback: False
114114
115115
model_config:
116116
model: llama_model
117117
model_name: TheBloke/Llama-2-70B-Chat-GGML # can also replace "70B" with either "7B" or "13B" on this line and the next
118118
weights_fname: llama-2-70b-chat.ggmlv3.q5_1.bin
119-
max_tokens: 2500
119+
max_tokens: 32000
120120
n_gpu_layers: 40
121121
n_batch: 512
122122
@@ -136,14 +136,14 @@ cache_config:
136136
cache: False
137137
caching_strategy: exact # alternative: similarity
138138
cache_db_version: 0.1
139-
url: <URL> # ignore this
139+
url: None # ignore this
140140
141141
feedback: False
142142
143143
model_config:
144144
model: huggingface_model
145145
model_name: TheBloke/Llama-2-70B-Chat-GGML # replace with any text-generation model on Hugging Face!
146-
max_tokens: 2500
146+
max_tokens: 32000
147147
n_gpu_layers: 40
148148
n_batch: 512
149149

0 commit comments

Comments
 (0)