-
-
-
- 
-
-
-
-
- Enterprise Data
-Feature Engineering
-
-
-
+
+
+
+
+
+
-
- Storage connectors
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+ Getting Started
+ +
+
+
+ Popular Guides
+ +
+
+Developer Resources
+ +
+
+
+
+
+
+ Feature Store
+Feature engineering and serving
+
+
-
+
+ + + Feature Groups +
+Organize and version your features
+
+
+ + + Feature Views +
+Create training sets and feature vectors
+
+
+ + Data Validation +
+Statistics, expectations, and monitoring
-
-
+
-
+
-
-
-
- Enterprise Feature Store
-
+
+
+
+ MLOps
+Model management and operations
+
+
+
+
+
+
- + + Model Registry +
+Version, store, and manage ML models
-
+
-
+
-
- Govern & Monitor
-
-
- Serve
-
-
- Share & Re-use
-
-
-
+ Create
-
+
+
+
+
+ Infrastructure
+Platform foundation and connectivity
+
+
+
+
+ + + Storage Connectors +
+Connect to external data platforms
+
+
+ + + Compute Engines +
+Python, Spark, Flink processing
+
+
+ + + Resource Management +
+GPU allocation and project governance
+
+
+
+Hopsworks K8s Installer
+
+
+
+Hopsworks is an enterprise-grade distributed AI Lakehouse platform with a feature store. Deploy a distributed system on your Kubernetes cluster with our installer:
+ + +
+```bash
+curl -O https://raw.githubusercontent.com/logicalclocks/hopsworks-k8s-installer/master/install-hopsworks.py
+python3 install-hopsworks.py
+```
+
+
+
+
+
+
+
+
+
+
+ Minimum Requirements:
+-
+
- Supported Platforms: AWS (EKS), Google Cloud (GKE), Azure (AKS), or OVHCloud +
- Kubernetes cluster version ≥ 1.27.0 +
- Minimum of 4-5 nodes recommended +
- Administrative access to your cloud platform +
Required Tools:
+-
+
- Kubernetes CLI (
kubectl)
+ - Package manager (
helm)
+ - Respective cloud CLI tool (
aws/gcloud/az)
+ - Other libraries (
boto3, PyYAML)
+
+
+ Enterprise Deployment
+For production and development deployment of Hopsworks Enterprise, we offer options on global or sovereign clouds with Enterprise SLAs.
+ +Deployment Options
+-
+
- Serverless (fastest way to start) +
- Any cloud provider +
- On-premises infrastructure +
- Hybrid setups +
+
+
Hopsworks Academy
+
+
+
+
+
+
Introduction to ML Systems with Hopsworks
+Get started with the Hopsworks platform and learn about its core capabilities for ML projects. Learn about best practices for building a modular, composable AI system that will scale with any + use cases for batch, real-time and even large language models.
+
+
-
+
+ Playing Now
- 
-
-
+
+
-
-
-
-
-
-
-
-
-
- Read API
-
-
-
-
+
- 
-
-
+
+
+
+
+ Featured Videos
+
+
+
+
+ 
-
-
-
- 
-
-
+
+
- Introduction to ML Systems
+Get started with Hopsworks platform
-
-
- 
-
- Azure
-
+
+
+
+
+ 
-
-
- 
-
-
- AWS
-
+
+
-
- Feature Pipelines in Production
+Code, Deployment & Monitoring
- 
-
-
-
-Hopsworks is a data platform for ML with a Python-centric Feature Store and MLOps capabilities. Hopsworks is a modular platform. You can use it as a standalone Feature Store, you can use it to manage, govern, and serve your models, and you can even use it to develop and operate feature, training and inference pipelines. Hopsworks brings collaboration for ML teams, providing a secure, governed platform for developing, managing, and sharing ML assets - features, models, training data, batch scoring data, logs, and more.
-
-## Python-Centric Feature Store
-Hopsworks is widely used as a standalone Feature Store. Hopsworks breaks the monolithic model development pipeline into separate feature and training pipelines, enabling both feature reuse and better tested ML assets. You can develop features by building feature pipelines in any Python (or Spark or Flink) environment, either inside or outside Hopsworks. You can use the Python frameworks you are familiar with to build production feature pipelines. You can compute aggregations in Pandas, validate feature data with Great Expectations, reduce your data dimensionality with embeddings and PCA, test your feature logic and features end-to-end with PyTest, and transform your categorical and numerical features with Scikit-Learn, TensorFlow, and PyTorch. You can orchestrate your feature pipelines with your Python framework of choice, including Hopsworks' own Airflow support.
-
-## The Widest Feature Store Capabilities
-Hopsworks Feature Store also supports feature pipelines in PySpark, Spark, Flink, and SQL. Offline features can either be stored in Hopsworks, as Hudi tables on object storage, or in external data lakehouses (Snowflake, Databricks, Redshift, BigQuery, any JDBC-enabled platform) via External Feature Groups. Online features are served by [RonDB](https://www.rondb.com), developed by Hopsworks as the lowest latency, highest throughput, highest availability data store for your features.
-
-## MLOps on Hopsworks
-Hopsworks provides model serving capabilities through KServe, with additional support for feature/prediction logging to Kafka (also part of Hopsworks), and secure, low-latency model deployments via Istio. Hopsworks also has a Model Registry for KServe, with support for versioning both models and model assets (such as KServe transformers). Hopsworks also includes a vector database to provide similarity search capabilities for embeddings, based on [OpenSearch](./concepts/mlops/opensearch.md).
-
-## Project-based Multi-Tenancy and Team Collaboration
-Hopsworks provides projects as a secure sandbox in which teams can collaborate and share ML assets. Hopsworks' unique multi-tenant project model even enables sensitive data to be stored in a shared cluster, while still providing fine-grained sharing capabilities for ML assets across project boundaries. Projects can be used to structure teams so that they have end-to-end responsibility from raw data to managed features and models. Projects can also be used to create development, staging, and production environments for data teams. All ML assets support versioning, lineage, and provenance provide all Hopsworks users with a complete view of the MLOps life cycle, from feature engineering through model serving.
-
-## Development and Operations
-Hopsworks provides a FTI (feature/training/inference) pipeline architecture for ML systems. Each part of the pipeline is defined in a Hopsworks job which corresponds to a Jupyter notebook, a python script or a jar. The production pipelines are then orchestrated with Airflow which is bundled in Hopsworks. Hopsworks provides several python environments that can be used and customized for each part of the FTI pipeline, for example switching between using PyTorch or TensorFlow in the training pipeline. You can train models on as many GPUs as are installed in a Hopsworks cluster and easily share them among users. You can also run Spark, Spark Streaming, or Flink programs on Hopsworks. JupyterLab is also bundled which can be used to run Python and Spark interactively.
-
-## Available on any Platform
-Hopsworks is available to be installed on a kubernetes cluster in the cloud on AWS, Azure, and GCP, and On-Prem (Ubuntu/Redhat compatible), even in air-gapped data centers. Hopsworks is also available as a serverless platform that manages and serves both your features and models.
-
-## Join the community
-- Ask questions and give us feedback in the [Hopsworks Community](https://community.hopsworks.ai/)
-- Follow us on [Twitter](https://twitter.com/hopsworks)
-- Check out all our latest [product releases](https://github.com/logicalclocks/hopsworks/releases)
-- Join our public [slack-channel](https://join.slack.com/t/public-hopsworks/shared_invite/zt-24fc3hhyq-VBEiN8UZlKsDrrLvtU4NaA )
-
-## Contribute
-We are building the most complete and modular ML platform available in the market, and we count on your support to continuously improve Hopsworks. Feel free to [give us suggestions](https://github.com/logicalclocks/hopsworks), [report bugs](https://github.com/logicalclocks/hopsworks/issues) and [add features to our library](https://github.com/logicalclocks/hopsworks-api) anytime.
+
+:28181
+
+* API: https://:8182
+
+* Default login: admin@hopsworks.ai / admin
+
+## Enterprise & Production
+For enterprise deployment, including:
+
+* Production environments
+
+* Custom configurations
+
+* Enterprise SLAs
+
+* Sovereign cloud options
+
+[Contact our team](https://www.hopsworks.ai/contact) for enterprise deployment options.
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index d8cdaf8a2..3b6b988ad 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,23 +1,20 @@
site_name: "Hopsworks Documentation"
-site_description: "Official documentation for Hopsworks and its Feature Store - an open source data-intensive AI platform used for the development and operation of machine learning models at scale."
+site_description: "Official documentation for Hopsworks AI Lakehouse and Feature Store - A data-intensive AI platform used for the development and operation of machine learning models at scale."
site_author: "Hopsworks"
site_url: "https://docs.hopsworks.ai/"
+use_directory_urls: true
# Repository
-repo_name: logicalclocks/hopsworks
-repo_url: https://github.com/logicalclocks/hopsworks
-edit_uri: ""
+# No repository link
strict: false
nav:
- - Home: index.md
- - Getting Started ↗: https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb
+ - index.md
- Tutorials:
- tutorials/index.md
- Concepts:
- Hopsworks Platform: concepts/hopsworks.md
- - MLOps Dictionary ↗: https://www.hopsworks.ai/mlops-dictionary?utm_source=web&utm_medium=docs
- Feature Store:
- Architecture: concepts/fs/index.md #hsfs
- Feature Groups:
@@ -244,27 +241,41 @@ nav:
- Access Audit Logs: setup_installation/admin/audit/audit-logs.md
- Export Audit Logs: setup_installation/admin/audit/export-audit-logs.md
- : https://docs.hopsworks.ai
- - Community ↗: https://community.hopsworks.ai/
+ - Serverless ↗: https://app.hopsworks.ai
+ - Community ↗: https://community.hopsworks.ai?utm_source=web&utm_medium=docs
+ - Dictionary ↗: https://www.hopsworks.ai/mlops-dictionary?utm_source=web&utm_medium=docs
theme:
name: material
custom_dir: docs/overrides
favicon: assets/images/favicon.ico
logo: assets/images/hops-logo.png
- icon:
- repo: fontawesome/brands/github
font:
text: "Roboto"
code: "IBM Plex Mono"
palette:
- accent: teal
- scheme: hopsworks
+ # Palette toggle for light mode
+ - media: "(prefers-color-scheme: light)"
+ scheme: hopsworks
+ accent: teal
+ toggle:
+ icon: material/brightness-7
+ name: Switch to dark mode
+
+ # Palette toggle for dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ accent: teal
+ toggle:
+ icon: material/brightness-4
+ name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.indexes
-
+ - content.code.copy
+
extra:
hopsworks_version: dev
version:
@@ -274,14 +285,12 @@ extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/hopsworks
- - icon: fontawesome/brands/github
- link: https://github.com/logicalclocks/hopsworks
- icon: fontawesome/brands/discourse
link: https://community.hopsworks.ai/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/hopsworks/
- icon: fontawesome/brands/slack
- link: https://bit.ly/publichopsworks
+ link: https://join.slack.com/t/public-hopsworks/shared_invite/zt-1uf21vitz-rhHKNdIf8GEiOf1EJ6Wzsw
analytics:
provider: google
property: G-64FEEXPSDN
@@ -290,11 +299,13 @@ extra_css:
- css/custom.css
- css/marctech.css
- css/dropdown.css
+ - css/animation.css
extra_javascript:
- js/inject-api-links.js
- js/dropdown.js
- js/quickstart-fullscreen.js
+ - js/background-animation.js
plugins:
- search
-
-
-
-
+
- 
-
+
-
-
- 
-
-
-
-
-
-
-
-
-
+
-
-
-
+
-
Generating Training Data
+Training data from the features
-
-Hopsworks is a data platform for ML with a Python-centric Feature Store and MLOps capabilities. Hopsworks is a modular platform. You can use it as a standalone Feature Store, you can use it to manage, govern, and serve your models, and you can even use it to develop and operate feature, training and inference pipelines. Hopsworks brings collaboration for ML teams, providing a secure, governed platform for developing, managing, and sharing ML assets - features, models, training data, batch scoring data, logs, and more.
-
-## Python-Centric Feature Store
-Hopsworks is widely used as a standalone Feature Store. Hopsworks breaks the monolithic model development pipeline into separate feature and training pipelines, enabling both feature reuse and better tested ML assets. You can develop features by building feature pipelines in any Python (or Spark or Flink) environment, either inside or outside Hopsworks. You can use the Python frameworks you are familiar with to build production feature pipelines. You can compute aggregations in Pandas, validate feature data with Great Expectations, reduce your data dimensionality with embeddings and PCA, test your feature logic and features end-to-end with PyTest, and transform your categorical and numerical features with Scikit-Learn, TensorFlow, and PyTorch. You can orchestrate your feature pipelines with your Python framework of choice, including Hopsworks' own Airflow support.
-
-## The Widest Feature Store Capabilities
-Hopsworks Feature Store also supports feature pipelines in PySpark, Spark, Flink, and SQL. Offline features can either be stored in Hopsworks, as Hudi tables on object storage, or in external data lakehouses (Snowflake, Databricks, Redshift, BigQuery, any JDBC-enabled platform) via External Feature Groups. Online features are served by [RonDB](https://www.rondb.com), developed by Hopsworks as the lowest latency, highest throughput, highest availability data store for your features.
-
-## MLOps on Hopsworks
-Hopsworks provides model serving capabilities through KServe, with additional support for feature/prediction logging to Kafka (also part of Hopsworks), and secure, low-latency model deployments via Istio. Hopsworks also has a Model Registry for KServe, with support for versioning both models and model assets (such as KServe transformers). Hopsworks also includes a vector database to provide similarity search capabilities for embeddings, based on [OpenSearch](./concepts/mlops/opensearch.md).
-
-## Project-based Multi-Tenancy and Team Collaboration
-Hopsworks provides projects as a secure sandbox in which teams can collaborate and share ML assets. Hopsworks' unique multi-tenant project model even enables sensitive data to be stored in a shared cluster, while still providing fine-grained sharing capabilities for ML assets across project boundaries. Projects can be used to structure teams so that they have end-to-end responsibility from raw data to managed features and models. Projects can also be used to create development, staging, and production environments for data teams. All ML assets support versioning, lineage, and provenance provide all Hopsworks users with a complete view of the MLOps life cycle, from feature engineering through model serving.
-
-## Development and Operations
-Hopsworks provides a FTI (feature/training/inference) pipeline architecture for ML systems. Each part of the pipeline is defined in a Hopsworks job which corresponds to a Jupyter notebook, a python script or a jar. The production pipelines are then orchestrated with Airflow which is bundled in Hopsworks. Hopsworks provides several python environments that can be used and customized for each part of the FTI pipeline, for example switching between using PyTorch or TensorFlow in the training pipeline. You can train models on as many GPUs as are installed in a Hopsworks cluster and easily share them among users. You can also run Spark, Spark Streaming, or Flink programs on Hopsworks. JupyterLab is also bundled which can be used to run Python and Spark interactively.
-
-## Available on any Platform
-Hopsworks is available to be installed on a kubernetes cluster in the cloud on AWS, Azure, and GCP, and On-Prem (Ubuntu/Redhat compatible), even in air-gapped data centers. Hopsworks is also available as a serverless platform that manages and serves both your features and models.
-
-## Join the community
-- Ask questions and give us feedback in the [Hopsworks Community](https://community.hopsworks.ai/)
-- Follow us on [Twitter](https://twitter.com/hopsworks)
-- Check out all our latest [product releases](https://github.com/logicalclocks/hopsworks/releases)
-- Join our public [slack-channel](https://join.slack.com/t/public-hopsworks/shared_invite/zt-24fc3hhyq-VBEiN8UZlKsDrrLvtU4NaA )
-
-## Contribute
-We are building the most complete and modular ML platform available in the market, and we count on your support to continuously improve Hopsworks. Feel free to [give us suggestions](https://github.com/logicalclocks/hopsworks), [report bugs](https://github.com/logicalclocks/hopsworks/issues) and [add features to our library](https://github.com/logicalclocks/hopsworks-api) anytime.
+
+
+
-## Open-Source
-Hopsworks is available under the AGPL-V3 license. In plain English this means that you are free to use Hopsworks and even build paid services on it, but if you modify the source code, you should also release back your changes and any systems built around it as AGPL-V3.
+
+
+
+
+ For Data Engineers
+Build and optimize feature pipelines
+ +
+
+
+ For Data Scientists
+Build models using high-quality features
+ +
+
+For MLOps Engineers
+Deploy and monitor ML systems
+ +
+
-We're the best at what we do, and we strive to keep the same standard for our community!
-Our many thanks to the contributors of Hopsworks.
diff --git a/docs/js/background-animation.js b/docs/js/background-animation.js
new file mode 100644
index 000000000..82ce37798
--- /dev/null
+++ b/docs/js/background-animation.js
@@ -0,0 +1,186 @@
+/**
+ * Lightweight background animation with floating nodes
+ * Only runs on the index page
+ */
+
+document.addEventListener('DOMContentLoaded', function() {
+ // Only run on the index page - strict check
+ const currentPath = window.location.pathname;
+ console.log("Current path:", currentPath);
+
+ // Get the pathname without version part
+ const pathParts = currentPath.split('/').filter(part => part);
+
+ // Strict check for index paths only
+ // Should match exactly: /, /index.html, /latest/, /latest/index.html
+ // And equivalent version paths like /3.0/, /4.0/index.html
+ const isIndexPath = (
+ currentPath === '/' ||
+ currentPath === '/index.html' ||
+ (pathParts.length === 1 && pathParts[0].match(/^(latest|\d+\.\d+)$/)) ||
+ (pathParts.length === 2 && pathParts[0].match(/^(latest|\d+\.\d+)$/) && pathParts[1] === 'index.html')
+ );
+
+ if (!isIndexPath) {
+ console.log("Not on index page, skipping animation");
+ return;
+ }
+
+ console.log("On index page, running animation");
+
+ // Create canvas element
+ const canvas = document.createElement('canvas');
+ const ctx = canvas.getContext('2d');
+
+ // Add CSS class for styling
+ canvas.className = 'bg-animation-canvas';
+
+ // Additional inline styles (these can be moved to CSS if preferred)
+ canvas.style.opacity = '0.7'; // Increased opacity for visibility
+
+ // Find the hero section and insert the canvas into it
+ const heroSection = document.querySelector('.hero-section');
+ if (heroSection) {
+ // Make hero section position relative if it's not already
+ if (getComputedStyle(heroSection).position !== 'relative') {
+ heroSection.style.position = 'relative';
+ }
+
+ // Make sure overflow is hidden
+ heroSection.style.overflow = 'hidden';
+
+ // Insert at the beginning of the hero section
+ heroSection.insertBefore(canvas, heroSection.firstChild);
+ console.log("Canvas inserted into hero section");
+ } else {
+ console.warn("Hero section not found, inserting into body");
+ // Fallback to body insertion
+ document.body.insertBefore(canvas, document.body.firstChild);
+ }
+
+ // Resize canvas to full window width
+ function resizeCanvas() {
+ // Always use window width to ensure full width
+ canvas.width = window.innerWidth;
+
+ // Use hero section height if available
+ if (heroSection) {
+ canvas.height = heroSection.offsetHeight;
+ } else {
+ canvas.height = window.innerHeight;
+ }
+
+ console.log(`Canvas resized to ${canvas.width}x${canvas.height}`);
+ }
+
+ // Initialize nodes
+ const NODES_COUNT = 25; // Increased node count
+ const nodes = [];
+
+ function initNodes() {
+ nodes.length = 0;
+
+ for (let i = 0; i < NODES_COUNT; i++) {
+ nodes.push({
+ x: Math.random() * canvas.width,
+ y: Math.random() * canvas.height,
+ radius: Math.random() * 4 + 2, // Larger radius for better visibility
+ speedX: (Math.random() - 0.5) * 0.3, // Slightly faster movement
+ speedY: (Math.random() - 0.5) * 0.3,
+ opacity: Math.random() * 0.6 + 0.4, // Higher opacity
+ rotation: Math.random() * Math.PI * 2, // Random initial rotation
+ rotationSpeed: (Math.random() - 0.5) * 0.02 // Very slow rotation
+ });
+ }
+ }
+
+ // Draw nodes and connections
+ function draw() {
+ ctx.clearRect(0, 0, canvas.width, canvas.height);
+
+ // Get primary color from CSS variable (Hopsworks green)
+ const primaryColor = getComputedStyle(document.documentElement)
+ .getPropertyValue('--md-hopsworks-primary')
+ .trim() || '#1eb382';
+
+ // Update and draw nodes
+ for (let i = 0; i < nodes.length; i++) {
+ const node = nodes[i];
+
+ // Move nodes
+ node.x += node.speedX;
+ node.y += node.speedY;
+
+ // Update rotation
+ node.rotation += node.rotationSpeed;
+
+ // Bounce off edges
+ if (node.x < 0 || node.x > canvas.width) node.speedX *= -1;
+ if (node.y < 0 || node.y > canvas.height) node.speedY *= -1;
+
+ // Draw node as a rotated square
+ ctx.save();
+ ctx.translate(node.x, node.y);
+ ctx.rotate(node.rotation);
+
+ ctx.fillStyle = `rgba(${hexToRgb(primaryColor)}, ${node.opacity})`;
+ ctx.fillRect(
+ -node.radius,
+ -node.radius,
+ node.radius * 2,
+ node.radius * 2
+ );
+
+ ctx.restore();
+
+ // Draw connections to nearby nodes
+ for (let j = i + 1; j < nodes.length; j++) {
+ const otherNode = nodes[j];
+ const dx = node.x - otherNode.x;
+ const dy = node.y - otherNode.y;
+ const distance = Math.sqrt(dx * dx + dy * dy);
+
+ // Only connect close nodes
+ if (distance < 200) { // Increased connection distance
+ ctx.beginPath();
+ ctx.moveTo(node.x, node.y);
+ ctx.lineTo(otherNode.x, otherNode.y);
+ // Make lines more visible based on distance
+ const lineOpacity = (1 - distance / 200) * 0.4; // More visible lines
+ ctx.strokeStyle = `rgba(${hexToRgb(primaryColor)}, ${lineOpacity})`;
+ ctx.lineWidth = 1; // Thicker lines
+ ctx.stroke();
+ }
+ }
+ }
+
+ requestAnimationFrame(draw);
+ }
+
+ // Helper function to convert hex to rgb
+ function hexToRgb(hex) {
+ // Remove # if present
+ hex = hex.replace(/^#/, '');
+
+ // Parse hex components to RGB
+ const bigint = parseInt(hex, 16);
+ const r = (bigint >> 16) & 255;
+ const g = (bigint >> 8) & 255;
+ const b = bigint & 255;
+
+ return `${r}, ${g}, ${b}`;
+ }
+
+ // Initialize canvas and animation
+ // Final check - we should only reach this code on the index page
+ // Only initialize if we have a hero section
+ if (document.querySelector('.hero-section')) {
+ window.addEventListener('resize', resizeCanvas);
+ resizeCanvas();
+ initNodes();
+ draw();
+ console.log("Animation started successfully");
+ } else {
+ console.warn("Hero section not found, animation not started");
+ }
+});
\ No newline at end of file
diff --git a/docs/js/dropdown.js b/docs/js/dropdown.js
index 4f0a7e8a7..529b06c7c 100644
--- a/docs/js/dropdown.js
+++ b/docs/js/dropdown.js
@@ -1,3 +1,131 @@
-document.getElementsByClassName("md-tabs__link")[6].style.display = "none";
-document.getElementsByClassName("md-tabs__link")[8].style.display = "none";
+document.addEventListener('DOMContentLoaded', function() {
+ // Setup API dropdown without reordering navigation
+ const tabsContainer = document.querySelector('.md-tabs__list');
+ if (!tabsContainer) return; // Safety check
+
+ // Find API navigation item
+ const apiLinkIndex = Array.from(tabsContainer.children).findIndex(item =>
+ item.textContent.trim().includes('API')
+ );
+
+ // Only proceed if we found the API item
+ if (apiLinkIndex !== -1) {
+ // Create API dropdown replacement
+ setupApiDropdown(tabsContainer, apiLinkIndex);
+ }
+});
+/**
+ * Sets up the API dropdown menu
+ */
+function setupApiDropdown(tabsContainer, apiLinkIndex) {
+ // Get the original item to replace
+ const apiLinkItem = tabsContainer.children[apiLinkIndex];
+
+ // Create our new modal button
+ const apiBtn = document.createElement('button');
+ apiBtn.id = 'api-modal-btn';
+ apiBtn.textContent = 'API';
+ apiBtn.setAttribute('type', 'button');
+ apiBtn.setAttribute('aria-haspopup', 'true');
+ apiBtn.setAttribute('aria-expanded', 'false');
+
+ // Create a list item to hold the button
+ const apiListItem = document.createElement('li');
+ apiListItem.className = 'md-tabs__item';
+
+ // Copy height and padding style from original items to maintain consistency
+ const originalItem = tabsContainer.children[0];
+ if (originalItem) {
+ const computedStyle = window.getComputedStyle(originalItem);
+ apiListItem.style.height = computedStyle.height;
+ }
+
+ apiListItem.appendChild(apiBtn);
+
+ // Replace the original API link with our button
+ tabsContainer.replaceChild(apiListItem, apiLinkItem);
+
+ // Create modal elements
+ const modalContainer = document.createElement('div');
+ modalContainer.id = 'api-modal-container';
+
+ const modalContent = document.createElement('div');
+ modalContent.id = 'api-modal-content';
+
+ const modalHeader = document.createElement('div');
+ modalHeader.id = 'api-modal-header';
+ modalHeader.textContent = 'API Documentation';
+
+ const closeBtn = document.createElement('span');
+ closeBtn.id = 'api-modal-close';
+ closeBtn.innerHTML = '×';
+ modalHeader.appendChild(closeBtn);
+
+ modalContent.appendChild(modalHeader);
+
+ // Add API links
+ const hopsworksApiLink = document.createElement('a');
+ hopsworksApiLink.id = 'hopsworks_api_link';
+ hopsworksApiLink.href = 'https://docs.hopsworks.ai/hopsworks-api/latest/generated/api/login/';
+ hopsworksApiLink.textContent = 'Hopsworks API';
+ modalContent.appendChild(hopsworksApiLink);
+
+ const hsfsJavadocLink = document.createElement('a');
+ hsfsJavadocLink.id = 'hsfs_javadoc_link';
+ hsfsJavadocLink.href = 'https://docs.hopsworks.ai/hopsworks-api/latest/javadoc';
+ hsfsJavadocLink.textContent = 'Feature Store JavaDoc';
+ modalContent.appendChild(hsfsJavadocLink);
+
+ modalContainer.appendChild(modalContent);
+ document.body.appendChild(modalContainer);
+
+ // Position and open modal when button is clicked
+ apiBtn.addEventListener('click', function(e) {
+ e.preventDefault();
+
+ // Toggle dropdown visibility
+ if (modalContainer.style.display === 'block') {
+ modalContainer.style.display = 'none';
+ apiBtn.setAttribute('aria-expanded', 'false');
+ } else {
+ // Get button position
+ const rect = apiBtn.getBoundingClientRect();
+
+ // Position the dropdown right under the button
+ modalContainer.style.top = (rect.bottom + window.scrollY) + 'px';
+ modalContainer.style.left = (rect.left + window.scrollX) + 'px';
+
+ // Display the dropdown
+ modalContainer.style.display = 'block';
+ apiBtn.setAttribute('aria-expanded', 'true');
+ }
+
+ // Prevent event from bubbling to document
+ e.stopPropagation();
+ });
+
+ // Close when close button is clicked
+ closeBtn.addEventListener('click', function() {
+ modalContainer.style.display = 'none';
+ apiBtn.setAttribute('aria-expanded', 'false');
+ });
+
+ // Close when clicking anywhere else on the page
+ document.addEventListener('click', function(e) {
+ if (modalContainer.style.display === 'block' &&
+ !modalContainer.contains(e.target) &&
+ e.target !== apiBtn) {
+ modalContainer.style.display = 'none';
+ apiBtn.setAttribute('aria-expanded', 'false');
+ }
+ });
+
+ // Close on escape key
+ document.addEventListener('keydown', function(e) {
+ if (e.key === 'Escape' && modalContainer.style.display === 'block') {
+ modalContainer.style.display = 'none';
+ apiBtn.setAttribute('aria-expanded', 'false');
+ }
+ });
+}
\ No newline at end of file
diff --git a/docs/js/inject-api-links.js b/docs/js/inject-api-links.js
index 89082c67d..11fbd7da8 100644
--- a/docs/js/inject-api-links.js
+++ b/docs/js/inject-api-links.js
@@ -2,27 +2,44 @@ window.addEventListener("DOMContentLoaded", function () {
var windowPathNameSplits = window.location.pathname.split("/");
var majorVersionRegex = new RegExp("(\\d+[.]\\d+)");
var latestRegex = new RegExp("latest");
- if (majorVersionRegex.test(windowPathNameSplits[1])) { // On landing page docs.hopsworks.api/4.0 - URL contains major version
- // Version API dropdown
- document.getElementById("hopsworks_api_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + windowPathNameSplits[1] + "/generated/api/login/";
- document.getElementById("hsfs_javadoc_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + windowPathNameSplits[1] + "/javadoc";
- } else { // on / docs.hopsworks.api/hopsworks-api/4.0
- if (latestRegex.test(windowPathNameSplits[2]) || latestRegex.test(windowPathNameSplits[1])) {
- var majorVersion = "latest";
- } else {
- var apiVersion = windowPathNameSplits[2];
- var majorVersion = apiVersion.match(majorVersionRegex)[0];
+ var majorVersion = "latest"; // Default version
+
+ // Determine the current version from URL
+ if (majorVersionRegex.test(windowPathNameSplits[1])) {
+ // On landing page docs.hopsworks.api/4.0 - URL contains major version
+ majorVersion = windowPathNameSplits[1];
+ } else if (!latestRegex.test(windowPathNameSplits[2]) && !latestRegex.test(windowPathNameSplits[1])) {
+ // If we're not on latest, try to parse version
+ var apiVersion = windowPathNameSplits[2];
+ if (apiVersion && majorVersionRegex.test(apiVersion)) {
+ majorVersion = apiVersion.match(majorVersionRegex)[0];
+ }
+ }
+
+ // Only update external API links, not navigation links for local development
+ var hopsworksApiLink = document.getElementById("hopsworks_api_link");
+ var hsfsJavadocLink = document.getElementById("hsfs_javadoc_link");
+
+ if (hopsworksApiLink) {
+ hopsworksApiLink.href = "https://docs.hopsworks.ai/hopsworks-api/" + majorVersion + "/generated/api/login/";
+ }
+
+ if (hsfsJavadocLink) {
+ hsfsJavadocLink.href = "https://docs.hopsworks.ai/hopsworks-api/" + majorVersion + "/javadoc";
+ }
+
+ // Skip updating local navigation links when in development mode
+ if (window.location.hostname === "docs.hopsworks.ai") {
+ // Only update links when on the production site
+ var navLinks = document.getElementsByClassName("md-tabs__link");
+ if (navLinks.length >= 7) {
+ navLinks[0].href = "https://docs.hopsworks.ai/" + majorVersion;
+ navLinks[1].href = "https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb";
+ navLinks[2].href = "https://docs.hopsworks.ai/" + majorVersion + "/tutorials/";
+ navLinks[3].href = "https://docs.hopsworks.ai/" + majorVersion + "/concepts/hopsworks/";
+ navLinks[4].href = "https://docs.hopsworks.ai/" + majorVersion + "/user_guides/";
+ navLinks[5].href = "https://docs.hopsworks.ai/" + majorVersion + "/setup_installation/aws/getting_started/";
+ // navLinks[6] is for API, which is handled by dropdown.js
}
- // Version main navigation
- document.getElementsByClassName("md-tabs__link")[0].href = "https://docs.hopsworks.ai/" + majorVersion;
- document.getElementsByClassName("md-tabs__link")[1].href = "https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb";
- document.getElementsByClassName("md-tabs__link")[2].href = "https://docs.hopsworks.ai/" + majorVersion + "/tutorials/";
- document.getElementsByClassName("md-tabs__link")[3].href = "https://docs.hopsworks.ai/" + majorVersion + "/concepts/hopsworks/";
- document.getElementsByClassName("md-tabs__link")[4].href = "https://docs.hopsworks.ai/" + majorVersion + "/user_guides/";
- document.getElementsByClassName("md-tabs__link")[5].href = "https://docs.hopsworks.ai/" + majorVersion + "/setup_installation/aws/getting_started/";
- document.getElementsByClassName("md-tabs__link")[6].href = "https://docs.hopsworks.ai/" + majorVersion + "/admin/";
- // Version API dropdown
- document.getElementById("hopsworks_api_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + majorVersion + "/generated/api/login/";
- document.getElementById("hsfs_javadoc_link").href = "https://docs.hopsworks.ai/hopsworks-api/" + majorVersion + "/javadoc";
}
});
diff --git a/docs/js/layout_improvement.js b/docs/js/layout_improvement.js
new file mode 100644
index 000000000..a9d8e54f4
--- /dev/null
+++ b/docs/js/layout_improvement.js
@@ -0,0 +1,187 @@
+document.addEventListener('DOMContentLoaded', function() {
+ // Add toggle functionality for the table of contents
+ const tocSidebar = document.querySelector('.md-sidebar--secondary');
+ if (tocSidebar) {
+ tocSidebar.addEventListener('click', function(e) {
+ if (e.target === tocSidebar || e.target === tocSidebar.querySelector('::before')) {
+ if (window.innerWidth >= 1220) {
+ tocSidebar.classList.toggle('md-sidebar--collapsed');
+ } else {
+ tocSidebar.classList.toggle('md-sidebar--expanded');
+ }
+ }
+ });
+ }
+
+ // Apply full-width class to content area if page has full_width frontmatter
+ const contentInner = document.querySelector('.md-content__inner');
+ if (document.body.hasAttribute('data-full-width')) {
+ contentInner.classList.add('full-width');
+ }
+
+ // Initialize image zoom functionality
+ initImageZoom();
+});
+
+/**
+ * Image Zoom Functionality
+ * Makes images in documentation zoomable by clicking on them
+ */
+function initImageZoom() {
+ // Create modal container
+ const modal = document.createElement('div');
+ modal.className = 'img-modal';
+ modal.setAttribute('role', 'dialog');
+ modal.setAttribute('aria-modal', 'true');
+ modal.setAttribute('aria-label', 'Image zoom view');
+
+ // Create modal image
+ const modalImg = document.createElement('img');
+ modalImg.className = 'modal-content';
+ modalImg.setAttribute('alt', '');
+
+ // Create close button
+ const closeBtn = document.createElement('span');
+ closeBtn.className = 'close-zoom';
+ closeBtn.innerHTML = '×';
+ closeBtn.setAttribute('title', 'Close (Esc)');
+
+ // Create loading spinner
+ const spinner = document.createElement('div');
+ spinner.className = 'zoom-loading-spinner';
+
+ // Create help text
+ const helpText = document.createElement('div');
+ helpText.className = 'zoom-info-text';
+ helpText.textContent = 'Click or press Esc to close';
+
+ // Add elements to modal
+ modal.appendChild(closeBtn);
+ modal.appendChild(spinner);
+ modal.appendChild(modalImg);
+ modal.appendChild(helpText);
+
+ // Add modal to page
+ document.body.appendChild(modal);
+
+ // Hide spinner when image loads
+ modalImg.onload = function() {
+ spinner.style.display = 'none';
+ };
+
+ // Process all suitable images in the document
+ function processImages() {
+ // Select all content images
+ const images = document.querySelectorAll('.md-content img:not([data-zoom-processed])');
+
+ images.forEach(img => {
+ // Skip small images, icons and emojis
+ if (img.complete && (img.naturalWidth < 100 || img.naturalHeight < 100)) {
+ img.setAttribute('data-zoom-processed', 'skip');
+ return;
+ }
+
+ if (img.classList.contains('twemoji') ||
+ img.classList.contains('emojione') ||
+ img.alt === 'Logo') {
+ img.setAttribute('data-zoom-processed', 'skip');
+ return;
+ }
+
+ // Mark as zoomable
+ img.setAttribute('data-zoomable', 'true');
+ img.setAttribute('data-zoom-processed', 'true');
+ img.style.cursor = 'zoom-in';
+ img.title = 'Click to zoom';
+
+ // Create wrapper and zoom indicator
+ const parent = img.parentElement;
+
+ // Don't process images that are in links
+ if (parent.tagName === 'A') {
+ img.setAttribute('data-zoom-processed', 'skip');
+ return;
+ }
+
+ // Prepare container
+ let container;
+ if (parent.tagName !== 'DIV' && parent.tagName !== 'FIGURE' && parent.tagName !== 'P') {
+ container = document.createElement('div');
+ container.className = 'zoom-image-container';
+ img.parentNode.insertBefore(container, img);
+ container.appendChild(img);
+ } else {
+ container = parent;
+ container.classList.add('zoom-image-container');
+ }
+
+ // Add zoom indicator
+ const indicator = document.createElement('div');
+ indicator.className = 'zoom-indicator';
+ indicator.innerHTML = '🔍';
+ container.appendChild(indicator);
+
+ // Add click handler
+ img.addEventListener('click', function(e) {
+ e.preventDefault();
+
+ // Show modal
+ modal.style.display = 'block';
+
+ // Show loading spinner while image loads
+ spinner.style.display = 'block';
+
+ // Set image source
+ modalImg.src = this.src;
+ modalImg.alt = this.alt || '';
+
+ // Hide spinner if image is already cached
+ if (modalImg.complete) {
+ spinner.style.display = 'none';
+ }
+ });
+ });
+ }
+
+ // Process images initially
+ processImages();
+
+ // Set up observer for dynamically loaded content
+ const observer = new MutationObserver(function(mutations) {
+ let newContent = false;
+ mutations.forEach(function(mutation) {
+ if (mutation.addedNodes.length) {
+ newContent = true;
+ }
+ });
+
+ if (newContent) {
+ processImages();
+ }
+ });
+
+ // Start observing
+ observer.observe(document.body, {
+ childList: true,
+ subtree: true
+ });
+
+ // Close modal when clicking X
+ closeBtn.addEventListener('click', function() {
+ modal.style.display = 'none';
+ });
+
+ // Close modal when clicking anywhere
+ modal.addEventListener('click', function(e) {
+ if (e.target === modal) {
+ modal.style.display = 'none';
+ }
+ });
+
+ // Close modal with Escape key
+ document.addEventListener('keydown', function(e) {
+ if (e.key === 'Escape' && modal.style.display === 'block') {
+ modal.style.display = 'none';
+ }
+ });
+}
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
index 7fc85fb25..1edd0740e 100644
--- a/docs/overrides/main.html
+++ b/docs/overrides/main.html
@@ -5,4 +5,62 @@
Click here to go to latest.
+{% endblock %}
+
+{% block extrahead %}
+ {{ super() }}
+ {% if page and page.meta and page.meta.full_width %}
+
+ {% endif %}
+{% endblock %}
+
+{% block scripts %}
+ {{ super() }}
+
+
+
{% endblock %}
\ No newline at end of file
diff --git a/docs/robots.txt b/docs/robots.txt
index a96e321af..a7a6bb0a0 100644
--- a/docs/robots.txt
+++ b/docs/robots.txt
@@ -1,4 +1,10 @@
User-agent: *
-Disallow:
+Disallow: /
+Allow: /4.1/
+Allow: /latest/
-Sitemap: https://docs.hopsworks.ai/3.2/sitemap.xml
\ No newline at end of file
+Allow: /hopsworks-api/4.1/
+Allow: /hopsworks-api/latest/
+
+Allow: /hopsworks-api/4.1/javadoc/
+Allow: /hopsworks-api/latest/javadoc/
\ No newline at end of file
diff --git a/docs/setup_installation/on_prem/contact_hopsworks.md b/docs/setup_installation/on_prem/contact_hopsworks.md
index fee9e4600..cca5529a3 100644
--- a/docs/setup_installation/on_prem/contact_hopsworks.md
+++ b/docs/setup_installation/on_prem/contact_hopsworks.md
@@ -1,11 +1,63 @@
----
-description: Requirements and instructions on how to install the Hopsworks on-premises.
----
+# Hopsworks Quick Setup Guide
-# Hopsworks On-Premise Installation
+## Quick Start Script
+Get up and running with a single command:
+```bash
+curl -O https://raw.githubusercontent.com/logicalclocks/hopsworks-k8s-installer/master/install-hopsworks.py
+python3 install-hopsworks.py
+```
-It is possible to use Hopsworks on-premises, which means that companies can run their machine learning workloads on their own hardware and infrastructure, rather than relying on a cloud provider. This can provide greater flexibility, control, and cost savings, as well as enabling companies to meet specific compliance and security requirements.
+## Essential Information
+Hopsworks is an enterprise-grade distributed AI Lakehouse platform with a feature store. Currently supports:
-Working on-premises with Hopsworks typically involves collaboration with the Hopsworks engineering teams, as each infrastructure is unique and requires a tailored approach to deployment and configuration. The process begins with an assessment of the company's existing infrastructure and requirements, including network topology, security policies, and hardware specifications.
+* Amazon Web Services (EKS)
-For further details about on-premise installations; [contact us](https://www.hopsworks.ai/contact).
+* Google Cloud Platform (GKE)
+
+* Microsoft Azure (AKS)
+
+* OVHCloud
+
+## Technical Requirements
+
+* Kubernetes cluster version ≥ 1.27.0
+
+* 4-5 nodes minimum
+
+* Required tools:
+ * kubectl
+ * helm
+ * Cloud CLI (aws/gcloud/az)
+
+## For the Startups and Enthusiasts
+Want to dive deeper? Here's what you need:
+
+### Default Setup
+
+* AWS: m6i.2xlarge instances, EBS GP3 storage
+
+* GCP: n2-standard-8 instances
+
+* Azure: Standard_D8_v4 instances
+
+### Access Points
+Once installed, find your services at:
+
+* UI: https://
+ 
+ 
+ 
+