forked from jupyterlab/jupyter-ai
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates README, adds screen shots (jupyterlab#56)
- Loading branch information
1 parent
86ae8c5
commit 67fde68
Showing
4 changed files
with
16 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,30 @@ | ||
# jupyter-ai | ||
|
||
[](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 | ||
``` | ||
 | ||
|
||
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 | ||
``` | ||
 | ||
|
||
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 | ||
``` | ||
 | ||
|
||
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). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.