Skip to content

Commit b9721c8

Browse files
committed
Merge branch 'main' of github.com:squaredtechnologies/vizly-notebook
2 parents e26d0d2 + e05146c commit b9721c8

File tree

12 files changed

+223
-266
lines changed

12 files changed

+223
-266
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</a>
1010
</h1>
1111
<p align="center">
12-
AI-powered Jupyter Notebook built using React
12+
AI-powered Jupyter Notebook
1313
</p>
1414
<p align="center">
1515
<a href="https://www.thread.dev/"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=orange"/></a>
@@ -21,9 +21,9 @@ AI-powered Jupyter Notebook built using React
2121
<a href="https://github.com/squaredtechnologies/thread"><img src="https://img.shields.io/github/stars/squaredtechnologies/thread" /></a>
2222
</p>
2323

24-
[Thread](https://www.thread.dev) is a Jupyter alternative that combines the experience of OpenAI's code interpreter with the familiar development environment of a Python notebook. With Thread, you can use natural language to generate cells, edit code, ask questions or fix errors all while being able to edit or re-run code as you would in a regular Jupyter Notebook.
24+
[Thread](https://www.thread.dev) is a Jupyter alternative that integrates an AI copilot into your Jupyter Notebook editing experience.
2525

26-
Best of all, Thread runs locally, and can be used for free with your own API key. To start:
26+
Best of all, Thread runs locally and can be used for free with [Ollama](https://github.com/ollama/ollama) or your own API key. To start:
2727

2828
```
2929
pip install thread-dev
@@ -35,22 +35,6 @@ To start thread-dev, run the following
3535
thread
3636
```
3737

38-
or
39-
40-
```
41-
jupyter thread
42-
```
43-
44-
![ThreadIntro](https://github.com/squaredtechnologies/thread/assets/18422723/ac49e65b-e8f7-4e7b-a349-76cf533178df)
45-
46-
# Using Thread with Ollama
47-
48-
With Thread, you can use Ollama for a fully offline AI experience. To begin, install and run thread using the commands above.
49-
50-
# Demo
51-
52-
https://github.com/squaredtechnologies/thread/assets/18422723/b0ef0d7d-bae5-48ad-b293-217b940385fb
53-
5438
# Key features
5539

5640
### 1. Familiar Jupyter Notebook editing experience
@@ -73,9 +57,11 @@ https://github.com/squaredtechnologies/thread/assets/18422723/b0ef0d7d-bae5-48ad
7357

7458
<img width="1112" alt="image" src="https://github.com/squaredtechnologies/thread/assets/18422723/93a16931-4236-4ab0-b5b5-673100af2ca0">
7559

76-
### 6. React frontend
60+
# Demo
7761

78-
- Thread is built from the ground up using React, hopefully making it more accessible to build on top of for a wider range of developers.
62+
https://github.com/squaredtechnologies/thread/assets/18422723/b0ef0d7d-bae5-48ad-b293-217b940385fb
63+
64+
![ThreadIntro](https://github.com/squaredtechnologies/thread/assets/18422723/ac49e65b-e8f7-4e7b-a349-76cf533178df)
7965

8066
# Feature Roadmap
8167

@@ -87,7 +73,7 @@ These are some of the features we are hoping to launch in the next few month. If
8773
- [ ] UI based chart creation
8874
- [ ] Ability to collaborate on notebooks
8975
- [ ] Publish notebooks as shareable webapps
90-
- [ ] Add support for Jupyter Widgets
76+
- [x] Add support for Jupyter Widgets
9177
- [ ] Add file preview for all file types
9278

9379
# Thread.dev Cloud
@@ -130,6 +116,28 @@ Then:
130116
yarn dev --port 5001
131117
```
132118

119+
# Using Thread with Ollama
120+
121+
You can use [Ollama](https://github.com/ollama/ollama) for a fully offline AI experience. To begin, install and run thread using the commands above.
122+
123+
Once you have run thread, in the bottom left, select the Settings icon:
124+
125+
![image](https://github.com/squaredtechnologies/thread/assets/18422723/b7dd8546-9aaa-47fe-b241-4f9ed085b633)
126+
127+
Next, select the Model Settings setting:
128+
129+
![image](https://github.com/squaredtechnologies/thread/assets/18422723/47e9f1f2-dd81-4aa1-9290-5e8c9445766a)
130+
131+
This is what you will see:
132+
133+
![image](https://github.com/squaredtechnologies/thread/assets/18422723/b218f005-afa4-40d6-835e-d2b6e14757b5)
134+
135+
Navigate to Ollama and enter your model details:
136+
137+
![image](https://github.com/squaredtechnologies/thread/assets/18422723/8b5cc906-d261-409d-b843-068be69ed410)
138+
139+
Use Ctrl / Cmd + K and try running a query to see how it looks!
140+
133141
# Why we built Thread
134142

135143
We initially got the idea when building [Vizly](https://vizly.fyi/) a tool that lets non-technical users ask questions from their data. While Vizly is powerful at performing data transformations, as engineers, we often felt that natural language didn't give us enough freedom to edit the code that was generated or to explore the data further for ourselves. That is what gave us the inspiration to start Thread.

src/components/AppLayout.tsx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import FileViewModal from "./modals/file-view/FileViewModal";
66
import KernelSelectionModal from "./modals/kernel-selection/KernelSelectionModal";
77
import ModelSettingsModal from "./modals/model-settings/ModelSettingsModal";
88
import QueryLimitModal from "./modals/query-limit/QueryLimitModal";
9-
import ServerSettingsModal from "./modals/server-settings/ServerSettingsModal";
109
import { initializeServerConnection } from "./notebook/Notebook";
1110
import { useNotebookStore } from "./notebook/store/NotebookStore";
1211
import Sidebar from "./sidebar";
@@ -47,7 +46,6 @@ const AppLayout: React.FC<AppLayoutProps> = ({ children }) => {
4746
<FileViewModal />
4847
<QueryLimitModal />
4948
<InvalidConnectionModal />
50-
<ServerSettingsModal />
5149
<ModelSettingsModal />
5250
{children}
5351
</HStack>

0 commit comments

Comments
 (0)