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 4 commits into
base: main
Choose a base branch
from
Draft
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
63 changes: 46 additions & 17 deletions site/content/3.13/data-science/arangograph-notebooks.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,51 @@
---
title: ArangoGraph Notebooks
menuTitle: ArangoGraph Notebooks
title: ArangoDB Notebooks
menuTitle: ArangoDB Notebooks
weight: 130
description: >-
Colocated Jupyter Notebooks within the ArangoGraph Insights Platform
Colocated Jupyter Notebooks within the ArangoDB Platform
---

{{< tag "ArangoDB Platform" >}}

ArangoDB Notebooks provide a Jupyter-based environment for interactive data science
and GenAI, GraphRAG, graph analytics, and exploration of ArangoDB datasets.
The notebooks enable seamless integration of ArangoDB’s multi-model capabilities
with data science tools and libraries in Python.

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 notebooks 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 corressponding pages -->

## 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 >}}
ArangoGraph Notebooks don't include the ArangoGraphML services.
To enable the ArangoGraphML services,
[get in touch](https://www.arangodb.com/contact/)
with the ArangoDB team.
{{< /tip >}}

The ArangoGraph Notebook is a JupyterLab notebook embedded in the
[ArangoGraph Insights Platform](https://dashboard.arangodb.cloud/home?utm_source=docs&utm_medium=cluster_pages&utm_campaign=docs_traffic).
The notebook integrates seamlessly with the platform,
automatically connecting to ArangoGraph services and ArangoDB.
This makes it much easier to leverage these resources without having
to download any data locally or to remember user IDs, passwords, and endpoint URLs.

For more information, see the [Notebooks](../arangograph/notebooks.md) documentation.
To get a better understanding of how to interact with ArangoDB, use
the `GettingStarted.ipynb` template from the file browser.
{{< /tip >}}

<!-- TODO: Describe underlying services? -->

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