jupyter ai
v2.28.2
Jupyter AI está em incubação como parte da organização JupyterLab.
Jupyter AI conecta IA generativa com notebooks Jupyter. O Jupyter AI fornece uma maneira fácil e poderosa de explorar modelos generativos de IA em notebooks e melhorar sua produtividade no JupyterLab e no Jupyter Notebook. Mais especificamente, o Jupyter AI oferece:
%%ai que transforma o notebook Jupyter em um playground de IA generativo reproduzível. Isso funciona em qualquer lugar onde o kernel IPython seja executado (JupyterLab, Jupyter Notebook, Google Colab, Kaggle, VSCode, etc.).A documentação está disponível em ReadTheDocs.
Você precisará ter instalado o seguinte software para usar o Jupyter AI:
Além disso, você precisará de acesso a pelo menos um fornecedor modelo.
Importante
O JupyterLab 3 atingiu a data de término da manutenção em 15 de maio de 2024. Como resultado, não faremos backport de novos recursos para a ramificação v1 que oferece suporte ao JupyterLab 3. As correções para problemas críticos ainda serão backportadas até 31 de dezembro de 2024. Se você ainda estiver usando o JupyterLab 3, recomendamos fortemente que você atualize para o JupyterLab 4 o mais rápido possível . Para obter mais informações, consulte Fim da manutenção do JupyterLab 3 no Jupyter Blog.
Para usar qualquer provedor de modelo de IA neste notebook, você precisará das credenciais apropriadas, como chaves de API.
Obtenha as credenciais necessárias, como chaves de API, na plataforma do seu provedor de modelo.
Você pode definir suas chaves usando variáveis de ambiente ou em uma célula de código em seu notebook. Em uma célula de código, você pode usar o comando mágico %env para definir as credenciais da seguinte maneira:
# NOTE: Replace 'PROVIDER_API_KEY' with the credential key's name,
# and replace 'YOUR_API_KEY_HERE' with the key.
% env PROVIDER_API_KEY = YOUR_API_KEY_HEREPara obter instruções mais específicas para cada provedor de modelo, consulte a documentação dos provedores de modelo.
Abaixo está uma visão geral simplificada do processo de instalação e uso. Consulte nossa documentação oficial para obter detalhes sobre como instalar e usar o Jupyter AI.
Oferecemos 3 maneiras diferentes de instalar o Jupyter AI. Você pode ler cada seção para escolher o método de instalação que funciona melhor para você.
pip (recomendado)pipcondapip (recomendado) Se quiser instalar a extensão %%ai magic e JupyterLab, você pode executar:
$ pip install jupyter-ai[all]
Em seguida, reinicie o JupyterLab. Isso instalará todas as dependências opcionais, que fornecem acesso a todos os modelos atualmente suportados por jupyter-ai .
Se você não estiver usando o JupyterLab e quiser apenas instalar a magia Jupyter AI %%ai , você pode executar:
$ pip install jupyter-ai-magics[all]
jupyter-ai depende de jupyter-ai-magics , portanto, instalar jupyter-ai instala automaticamente jupyter-ai-magics .
pipA maioria dos provedores de modelo no Jupyter AI exige que uma dependência específica seja instalada antes de estarem disponíveis para uso. Elas são chamadas de dependências de provedor . As dependências do provedor são opcionais para o Jupyter AI, o que significa que o Jupyter AI pode ser instalado com ou sem qualquer dependência do provedor instalada. Se um provedor exigir uma dependência que não esteja instalada, seus modelos não serão listados na interface do usuário, o que permite selecionar um modelo de idioma.
Para realizar uma instalação mínima via pip sem nenhuma dependência de provedor, omita o grupo de dependência opcional [all] do nome do pacote:
pip install jupyter-ai
Ao instalar seletivamente dependências de provedor, você pode controlar quais modelos estão disponíveis em seu ambiente Jupyter AI.
Por exemplo, para instalar o Jupyter AI com suporte adicionado apenas para modelos Antrópicos, execute:
pip install jupyter-ai langchain-anthropic
Para obter mais informações sobre provedores de modelos e quais dependências eles exigem, consulte a tabela de provedores de modelos.
conda Como alternativa ao uso pip , você pode instalar jupyter-ai usando o Conda do canal conda-forge :
$ conda install conda-forge::jupyter-ai
A maioria dos provedores de modelo no Jupyter AI exige que uma dependência de provedor específica seja instalada antes de estarem disponíveis para uso. As dependências do provedor não são instaladas durante a instalação jupyter-ai do Conda Forge e devem ser instaladas separadamente conforme necessário.
Por exemplo, para instalar o Jupyter AI com suporte adicionado apenas para modelos OpenAI, execute:
conda install conda-forge::jupyter-ai conda-forge::langchain-openai
Para obter mais informações sobre provedores de modelos e quais dependências eles exigem, consulte a tabela de provedores de modelos.
%%ai A mágica %%ai funciona em qualquer lugar onde o kernel IPython seja executado, incluindo JupyterLab, Jupyter Notebook, Google Colab e Visual Studio Code.
Depois de instalar o %%ai magic, você pode habilitá-lo em qualquer notebook ou shell IPython executando:
%load_ext jupyter_ai_magics
ou:
%load_ext jupyter_ai
As capturas de tela abaixo são de notebooks no diretório examples/ deste pacote.
Então, você pode usar o comando mágico %%ai para especificar um modelo e um prompt de linguagem natural:
O Jupyter AI também pode gerar HTML e matemática para serem renderizados como saída de célula.
O Jupyter AI pode interpolar expressões IPython, permitindo executar prompts que incluem valores de variáveis.
A extensão Jupyter AI para JupyterLab oferece uma IU nativa que permite que vários usuários conversem com o assistente de conversação Jupyter AI. Se você tiver o JupyterLab instalado, ele deverá ser instalado e ativado quando você instalar o pacote jupyter_ai .
Para obter ajuda com a instalação e uso do Jupyter AI, consulte nossa documentação do usuário no ReadTheDocs.
Se você gostaria de contribuir com o Jupyter AI, consulte nossa documentação de contribuidor em ReadTheDocs.
