Skip to content

DOC-768 | ArangoDB Platform Notebooks #726

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
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
22 changes: 0 additions & 22 deletions site/content/3.13/data-science/arangograph-notebooks.md

This file was deleted.

53 changes: 53 additions & 0 deletions site/content/3.13/data-science/notebook-servers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Notebook Servers
menuTitle: Notebook Servers
weight: 130
description: >-
Colocated Jupyter Notebooks within the ArangoDB Platform
aliases:
- data-science/arangograph-notebooks
---

{{< tag "ArangoDB Platform" >}}

ArangoDB Notebooks provide a Python-based, Jupyter-compatible interface for building
and experimenting with graph-powered data, GenAI, and graph machine learning
workflows directly connected to ArangoDB databases. The notebook servers are
embedded in the ArangoGraph ecosystem and offer a
pre-configured environment where everything, including all the necessary services
and configurations, comes preloaded. You don't need to set up or configure the
infrastructure, and can immediately start using the GraphML and GenAI
functionalities.

The notebooks are primarily focused on the following solutions:
- **GraphRAG**: A complete solution for extracting entities
from text files to create a knowledge graph that you can then query with a
natural language interface.
- **GraphML**: Apply machine learning to graphs for link prediction,
classification, and similar tasks.
- **Integrations** : Use ArangoDB together with cuGraph, NetworkX, and other data science tools.

<!-- TODO: Add links to corresponding pages -->

The ArangoDB Notebooks also include the following services and tools:
- Automatically connect to ArangoDB databases and GenAI platform services
- [Magic commands](../arangograph/notebooks.md#arangograph-magic-commands)
that simplify database interactions
- [ArangoDB CLI Tools](../components/tools/) included in each Notebook server
to interact with ArangoDB from the command line

## Quickstart

1. In the ArangoDB Platform web interface, select a database.
2. Under **GenAI Tools**, click **Notebook servers**.
3. The **Notebook servers** page displays an overview of the notebook services. Click
**New notebook server** to create a new one.
4. After your notebook service is launched, you can start interacting with the
Jupyter interface.

{{< tip >}}
To get a better understanding of how to interact with ArangoDB, use
the `GettingStarted.ipynb` template from the file browser.
{{< /tip >}}

<!-- TODO: Add links to interactive tutorials? -->