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

Upgrade to JupyterLab 4 #296

Merged
merged 7 commits into from
Jul 27, 2023
Merged

Upgrade to JupyterLab 4 #296

merged 7 commits into from
Jul 27, 2023

Conversation

dlqqq
Copy link
Member

@dlqqq dlqqq commented Jul 26, 2023

Description

Updates the extension to JupyterLab 4. Closes #173.

We are currently debating which release this PR would be included under. This would be released either as 0.11.0 or as 1.0.0.

@dlqqq dlqqq added the enhancement New feature or request label Jul 26, 2023
@dlqqq dlqqq self-assigned this Jul 26, 2023
@dlqqq
Copy link
Member Author

dlqqq commented Jul 26, 2023

Had a discussion with the team. We have settled on the following versioning strategy:

  • Version 1.x will track Jupyter AI on JupyterLab 3 -- we will backport pertinent fixes and features as we deem fit.

  • Version 2.x will track Jupyter AI on JupyterLab 4. This will be the main branch and where all development takes place.

I will update the documentation in this PR accordingly.

@dlqqq
Copy link
Member Author

dlqqq commented Jul 26, 2023

I noticed an error in our user documentation:

You can use conda or pip to install Jupyter AI. If you're using macOS on an
Apple Silicon-based Mac (M1, M1 Pro, M2, etc.), we strongly recommend using
conda.

This is not true. We previously had users install certain dependencies via Conda due to upstream issues with Ray, but Jupyter AI does not have a Conda Forge distribution. You cannot install Jupyter AI with Conda, though you can install it within Conda. This issue is tracked here: #181

I'll update the documentation as I see fit here. @JasonWeill This should require your review.

@dlqqq
Copy link
Member Author

dlqqq commented Jul 26, 2023

I also took the liberty of rearranging the sections in the user documentation. For some reason, the "Requirements" and "Installation" section were interrupted by the "Model providers" section in between. I found this to be really confusing. I've moved "Model providers" after "Installation" to remedy this.

README.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
packages/jupyter-ai/pyproject.toml Outdated Show resolved Hide resolved
docs/source/users/index.md Outdated Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
docs/source/users/index.md Show resolved Hide resolved
@dlqqq
Copy link
Member Author

dlqqq commented Jul 26, 2023

@andrii-i

Did clean install following steps of the potential user and found this part confusing. Following the page from top to bottom, I/user have already done Prerequisites step via pip or conda.

Yes, but you did those prerequisites in a separate Conda environment. If you create and activate a new Conda environment, you need to reinstall JupyterLab.

Following structure would be more clear:

I disagree. That would involve duplicating sections of the documentation, which can easily cause users to be lost in a sea of mostly similar yet slightly different information.

I'd mention the need to make sure appropriate conda environment is active in the same spot conda is first mentioned on the page, in Prerequisites (or conda installation - Prerequisites if structure suggested in my comment above would be used)

We're assuming that they're following the documentation from top-down, i.e. it's guaranteed JupyterLab is already installed in the same Python environment before they try to install Jupyter AI.

@dlqqq
Copy link
Member Author

dlqqq commented Jul 26, 2023

@JasonWeill @andrii-i Thank you both for your feedback! I've implemented most of @JasonWeill's suggestions and formatted them in the documentation.

Copy link
Collaborator

@JasonWeill JasonWeill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this! One minor additional suggestion, otherwise it looks good to go.

README.md Show resolved Hide resolved
@andrii-i
Copy link
Collaborator

Did some manual testing and everything works well. Good job.

Following structure would be more clear:

I disagree. That would involve duplicating sections of the documentation, which can easily cause users to be lost in a sea of mostly similar yet slightly different information.

It's not clear to me which sections of the documentation would be duplicated that are not currently duplicated. At the same time I don't want to bikeshed / block PR based on this so please feel free to merge if you believe it's more clear this way.

@dlqqq dlqqq merged commit 4ad7fa6 into jupyterlab:main Jul 27, 2023
3 checks passed
@dlqqq dlqqq deleted the jl4 branch July 27, 2023 16:49
dbelgrod pushed a commit to dbelgrod/jupyter-ai that referenced this pull request Jun 10, 2024
* initial upgrade to JL4

* fix RTC

* update workflows and scripts to JL4

* update documentation to JL4

* pre-commit

* update documentation

* documentation updates per @JasonWeill
Marchlak pushed a commit to Marchlak/jupyter-ai that referenced this pull request Oct 28, 2024
* initial upgrade to JL4

* fix RTC

* update workflows and scripts to JL4

* update documentation to JL4

* pre-commit

* update documentation

* documentation updates per @JasonWeill
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JupyterLab 4 support
3 participants