Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates README, adds screen shots #56

Merged
merged 1 commit into from
Apr 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 16 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,30 @@
# jupyter-ai

[![Github Actions Status](https://github.com/jupyterlab/jupyter-ai/actions/workflows/check-release.yml/badge.svg)](https://github.com/jupyterlab/jupyter-ai/actions/workflows/check-release.yml)

A generative AI extension for Jupyter, to allow for AI to interact with notebooks and other documents. Documentation is available on [ReadTheDocs](https://jupyter-ai.readthedocs.io/en/latest/).

This is a monorepo that houses the core `jupyter_ai` package in addition to the
default supported AI modules. To learn more about the core package, please refer
to the [README](packages/jupyter-ai/README.md).

### Development install

Install the Hatch CLI, which installs the Hatchling build backend automatically.
From within a Jupyter notebook, Jupyter AI adds a `%%ai` magic command that can generate code:

```
pip install hatch
```
![Sample with code generation](./docs/source/_static/sample-code.png)

Then, simply enter the default hatch environment, which automatically installs
all dependencies and executes development setup when entering for the first
time. This command must be run with the current directory set to the root of the
monorepo (`<jupyter-ai-top>`).
Jupyter AI can also generate HTML and math to be rendered as cell output.

```
cd <jupyter-ai-top>
hatch shell
```
![Sample with HTML and math generation](./docs/source/_static/sample-html-math.png)

Set up your development environment and start the server:
Jupyter AI can interpolate IPython expressions, allowing you to run prompts
that include variable values.

```
jlpm dev
```
![Sample with code interpolation and markdown output](./docs/source/_static/sample-markdown.png)

Finally, in a separate shell, enter the hatch environment and build the project
after making any changes.

```
cd <jupyter-ai-top>
hatch shell
jlpm build
```

To exit the hatch environment at any time, exit like you would normally exit a
shell process, via the `exit` command or `Ctrl+D`.
This is a monorepo that houses the core `jupyter_ai` package in addition to the
default supported AI modules. To learn more about the core package, please refer
to the [core package's README](packages/jupyter-ai/README.md).

If installation fails for any reason, you will have to first uninstall the hatch
environment and then test your fix by reinstalling. See "Uninstall" procedure
below.
### Using

### Uninstall
For help with installing and using Jupyter AI, please see our
[user documentation on ReadTheDocs](https://jupyter-ai.readthedocs.io/en/latest/users/index.html).

Just remove the hatch environment:
### Contributing

```
hatch env remove default
```
If you would like to contribute to Jupyter AI, see our
[contributor documentation on ReadTheDocs](https://jupyter-ai.readthedocs.io/en/latest/contributors/index.html).
Binary file added docs/source/_static/sample-code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/sample-html-math.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/sample-markdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.