mkdocs.yml

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_author: "Hopsworks"
site_url: "https://docs.hopsworks.ai/"

# Repository
repo_name: logicalclocks/hopsworks
repo_url: https://github.com/logicalclocks/hopsworks
edit_uri: ""

strict: false

nav:
  - Home: index.md
  - Getting Started ↗: https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/quickstart.ipynb
  - 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:
              - Overview: concepts/fs/feature_group/fg_overview.md
              - Write APIs: concepts/fs/feature_group/write_apis.md
              - Feature Pipelines: concepts/fs/feature_group/feature_pipelines.md
              - External Feature Groups: concepts/fs/feature_group/external_fg.md
              - Spine Group: concepts/fs/feature_group/spine_group.md
              - Data Validation/Stats/Alerts: concepts/fs/feature_group/fg_statistics.md
              - Feature Monitoring: concepts/fs/feature_group/feature_monitoring.md
              - Versioning: concepts/fs/feature_group/versioning.md
              - On-Demand Feature: concepts/fs/feature_group/on_demand_feature.md
          - Feature Views:
              - Overview: concepts/fs/feature_view/fv_overview.md
              - Offline API: concepts/fs/feature_view/offline_api.md
              - Online API: concepts/fs/feature_view/online_api.md
              - Consistent Transformations: concepts/fs/feature_view/training_inference_pipelines.md
              - Statistics: concepts/fs/feature_view/statistics.md
              - Feature Monitoring: concepts/fs/feature_view/feature_monitoring.md
              - Versioning: concepts/fs/feature_view/versioning.md
      - Projects:
          - Governance: concepts/projects/governance.md
          - Data Storage/Sharing: concepts/projects/storage.md
          - Tags/Search/Lineage: concepts/projects/search.md
          - CI/CD: concepts/projects/cicd.md
      - MLOps:
          - Prediction Services: concepts/mlops/prediction_services.md
          - Model Training: concepts/mlops/training.md
          - Model Registry: concepts/mlops/registry.md
          - Model Serving: concepts/mlops/serving.md
          - Vector Database: concepts/mlops/opensearch.md
          - BI Tools: concepts/mlops/bi_tools.md
      - Development:
          - Outside Hopsworks: concepts/dev/outside.md # api-keys
          - Inside Hopsworks: concepts/dev/inside.md
  - Guides:
      - user_guides/index.md
      - Feature Store:
          - user_guides/fs/index.md
          - Storage Connector:
              - user_guides/fs/storage_connector/index.md
              - Configuration and Creation:
                  - JDBC: user_guides/fs/storage_connector/creation/jdbc.md
                  - Snowflake: user_guides/fs/storage_connector/creation/snowflake.md
                  - Kafka: user_guides/fs/storage_connector/creation/kafka.md
                  - HopsFS: user_guides/fs/storage_connector/creation/hopsfs.md
                  - S3: user_guides/fs/storage_connector/creation/s3.md
                  - Redshift: user_guides/fs/storage_connector/creation/redshift.md
                  - ADLS: user_guides/fs/storage_connector/creation/adls.md
                  - BigQuery: user_guides/fs/storage_connector/creation/bigquery.md
                  - GCS: user_guides/fs/storage_connector/creation/gcs.md
              - Usage: user_guides/fs/storage_connector/usage.md
          - Feature Group:
              - user_guides/fs/feature_group/index.md
              - Create: user_guides/fs/feature_group/create.md
              - Create External: user_guides/fs/feature_group/create_external.md
              - Deprecate: user_guides/fs/feature_group/deprecation.md
              - Data Types and Schema management: user_guides/fs/feature_group/data_types.md
              - Statistics: user_guides/fs/feature_group/statistics.md
              - Data Validation:
                  - Getting started: user_guides/fs/feature_group/data_validation.md
                  - Advanced guide: user_guides/fs/feature_group/data_validation_advanced.md
                  - Best practices: user_guides/fs/feature_group/data_validation_best_practices.md
              - Feature Monitoring:
                  - Getting started: user_guides/fs/feature_group/feature_monitoring.md
                  - Advanced guide: user_guides/fs/feature_monitoring/feature_monitoring_advanced.md
              - Notification: user_guides/fs/feature_group/notification.md
          - Feature View:
              - user_guides/fs/feature_view/index.md
              - Overview: user_guides/fs/feature_view/overview.md
              - Training data: user_guides/fs/feature_view/training-data.md
              - Batch data: user_guides/fs/feature_view/batch-data.md
              - Feature vectors: user_guides/fs/feature_view/feature-vectors.md
              - Feature server: user_guides/fs/feature_view/feature-server.md
              - Query: user_guides/fs/feature_view/query.md
              - Helper Columns: user_guides/fs/feature_view/helper-columns.md
              - Transformation Functions: user_guides/fs/feature_view/transformation-function.md
              - Spines: user_guides/fs/feature_view/spine-query.md
              - Feature Monitoring:
                  - Getting started: user_guides/fs/feature_view/feature_monitoring.md
                  - Advanced guide: user_guides/fs/feature_monitoring/feature_monitoring_advanced.md
          - Vector Similarity Search: user_guides/fs/vector_similarity_search.md
          - Compute Engines: user_guides/fs/compute_engines.md
          - Client Integrations:
              - user_guides/integrations/index.md
              - Python: user_guides/integrations/python.md
              - Databricks:
                  - Networking: user_guides/integrations/databricks/networking.md
                  - Hopsworks API Key: user_guides/integrations/databricks/api_key.md
                  - Configuration: user_guides/integrations/databricks/configuration.md
              - AWS Sagemaker: user_guides/integrations/sagemaker.md
              - AWS EMR:
                  - Networking: user_guides/integrations/emr/networking.md
                  - Configure EMR for the Hopsworks Feature Store: user_guides/integrations/emr/emr_configuration.md
              - Azure HDInsight: user_guides/integrations/hdinsight.md
              - Azure Machine Learning:
                  - Designer: user_guides/integrations/mlstudio_designer.md
                  - Notebooks: user_guides/integrations/mlstudio_notebooks.md
              - Apache Spark: user_guides/integrations/spark.md
              - Apache Flink: user_guides/integrations/flink.md
              - Apache Beam: user_guides/integrations/beam.md
              - Java: user_guides/integrations/java.md
          - Sharing: user_guides/fs/sharing/sharing.md
          - Tags: user_guides/fs/tags/tags.md
          - Provenance: user_guides/fs/provenance/provenance.md
          - Feature Monitoring:
              - user_guides/fs/feature_monitoring/index.md
              - Scheduled Statistics: user_guides/fs/feature_monitoring/scheduled_statistics.md
              - Statistics Comparison: user_guides/fs/feature_monitoring/statistics_comparison.md
              - Interactive Graph: user_guides/fs/feature_monitoring/interactive_graph.md
      - Projects:
          - user_guides/projects/index.md
          - Authentication:
              - Registration: user_guides/projects/auth/registration.md
              - Login: user_guides/projects/auth/login.md
              - Password Recovery: user_guides/projects/auth/recovery.md
              - OAuth2 Authentication: user_guides/projects/auth/oauth.md
              - LDAP Authentication: user_guides/projects/auth/ldap.md
              - Kerberos Authentication: user_guides/projects/auth/krb.md
              - Update Profile: user_guides/projects/auth/profile.md
          - Projects:
              - Create Project: user_guides/projects/project/create_project.md
              - Add Members: user_guides/projects/project/add_members.md
          - Python:
              - Install Library: user_guides/projects/python/python_install.md
              - Export environment: user_guides/projects/python/python_env_export.md
              - Recreate environment: user_guides/projects/python/python_env_recreate.md
              - Custom Commands: user_guides/projects/python/custom_commands.md
              - Python Environment History: user_guides/projects/python/environment_history.md
          - Jupyter:
              - Run Spark Notebook: user_guides/projects/jupyter/spark_notebook.md
              - Run Python Notebook: user_guides/projects/jupyter/python_notebook.md
              - Remote Filesystem Driver: user_guides/projects/jupyter/remote_filesystem_driver.md
          - Jobs:
              - Run PySpark Job: user_guides/projects/jobs/pyspark_job.md
              - Run Spark Job: user_guides/projects/jobs/spark_job.md
              - Run Python Job: user_guides/projects/jobs/python_job.md
              - Run Jupyter Notebook Job: user_guides/projects/jobs/notebook_job.md
              - Scheduling: user_guides/projects/jobs/schedule_job.md
          - Airflow: user_guides/projects/airflow/airflow.md
          - OpenSearch:
              - Connect: user_guides/projects/opensearch/connect.md
          - Kafka:
              - Create Schema: user_guides/projects/kafka/create_schema.md
              - Create Topic: user_guides/projects/kafka/create_topic.md
              - Produce messages: user_guides/projects/kafka/produce_messages.md
              - Consume messages: user_guides/projects/kafka/consume_messages.md
          - Git:
              - Configure Git Provider: user_guides/projects/git/configure_git_provider.md
              - Clone Repository: user_guides/projects/git/clone_repo.md
              - Repository Actions: user_guides/projects/git/repository_actions.md
          - Secrets:
              - Create Secret: user_guides/projects/secrets/create_secret.md
          - Api Keys:
              - Create API Key: user_guides/projects/api_key/create_api_key.md
          - AWS IAM Roles: user_guides/projects/iam_role/iam_role_chaining.md
      - MLOps:
          - user_guides/mlops/index.md
          - Model Registry:
              - user_guides/mlops/registry/index.md
              - Frameworks:
                  - TensorFlow: user_guides/mlops/registry/frameworks/tf.md
                  - Scikit-learn: user_guides/mlops/registry/frameworks/skl.md
                  - Python: user_guides/mlops/registry/frameworks/python.md
              - Model Schema: user_guides/mlops/registry/model_schema.md
              - Input Example: user_guides/mlops/registry/input_example.md
              - Model Evaluation Images: user_guides/mlops/registry/model_evaluation_images.md
          - Model Serving:
              - user_guides/mlops/serving/index.md
              - Deployment:
                  - Deployment creation: user_guides/mlops/serving/deployment.md
                  - Deployment state: user_guides/mlops/serving/deployment-state.md
              - Predictor: user_guides/mlops/serving/predictor.md
              - Transformer: user_guides/mlops/serving/transformer.md
              - Resource Allocation: user_guides/mlops/serving/resources.md
              - Inference Logger: user_guides/mlops/serving/inference-logger.md
              - Inference Batcher: user_guides/mlops/serving/inference-batcher.md
              - API Protocol: user_guides/mlops/serving/api-protocol.md
              - Troubleshooting: user_guides/mlops/serving/troubleshooting.md
          - Vector Database: user_guides/mlops/vector_database/index.md
      - Migration:
          - 2.X to 3.0: user_guides/migration/30_migration.md
  - Setup and Installation:
      - setup_installation/index.md
      - Client Installation:
          - user_guides/client_installation/index.md
      - AWS:
          - Getting Started: setup_installation/aws/getting_started.md
          - Cluster Creation: setup_installation/aws/cluster_creation.md
          - EKS integration: setup_installation/aws/eks_ecr_integration.md
          - Limiting Permissions: setup_installation/aws/restrictive_permissions.md
          - Custom Domain: setup_installation/aws/custom_domain_name.md
          - Cluster upgrade:
              - Version 3.0 or newer: setup_installation/aws/upgrade_3.0.md
              - Version 2.4 or newer: setup_installation/aws/upgrade_2.4.md
              - Version 2.2 or older: setup_installation/aws/upgrade.md
          - Troubleshooting: setup_installation/aws/troubleshooting.md
      - Azure:
          - Getting Started: setup_installation/azure/getting_started.md
          - Cluster Creation: setup_installation/azure/cluster_creation.md
          - AKS integration: setup_installation/azure/aks_acr_integration.md
          - Limiting Permissions: setup_installation/azure/restrictive_permissions.md
          - Cluster upgrade:
              - Version 3.0 or newer: setup_installation/azure/upgrade_3.0.md
              - Version 2.4 or newer: setup_installation/azure/upgrade_2.4.md
              - Version 2.2 or older: setup_installation/azure/upgrade.md
      - GCP:
          - Getting Started: setup_installation/gcp/getting_started.md
          - Cluster Creation: setup_installation/gcp/cluster_creation.md
          - Limiting Permissions: setup_installation/gcp/restrictive_permissions.md
          - GKE integration: setup_installation/gcp/gke_integration.md
      - Common:
          - The dashboard: setup_installation/common/dashboard.md
          - Settings: setup_installation/common/settings.md
          - Services: setup_installation/common/services.md
          - Adding and Removing workers: setup_installation/common/adding_removing_workers.md
          - Autoscaling: setup_installation/common/autoscaling.md
          - Backup: setup_installation/common/backup.md
          - Scaling up: setup_installation/common/scalingup.md
          - User management: setup_installation/common/user_management.md
          - Managed RonDB: setup_installation/common/rondb.md
          - ArrowFlight Server with DuckDB: setup_installation/common/arrow_flight_duckdb.md
          - Single Sign On:
              - Hopsworks:
                  - OAuth2: setup_installation/common/sso/oauth.md
                  - LDAP: setup_installation/common/sso/ldap.md
          - API Key: setup_installation/common/api_key.md
          - Terraform: setup_installation/common/terraform.md
      - On-Prem:
          - Hopsworks Installer: setup_installation/on_prem/hopsworks_installer.md
          - External Kafka cluster: setup_installation/on_prem/external_kafka_cluster.md
  - Administration:
      - Introduction: admin/index.md
      - Cluster Configuration: admin/variables.md
      - User Management: admin/user.md
      - Project Management: admin/project.md
      - Configure Alerts: admin/alert.md
      - Manage Services: admin/services.md
      - IAM Role Chaining: admin/roleChaining.md
      - Monitoring:
          - Services Dashboards: admin/monitoring/grafana.md
          - Export metrics: admin/monitoring/export-metrics.md
          - Services Logs: admin/monitoring/services-logs.md
      - Authentication:
          - Configure Authentication: admin/auth.md
          - Configure OAuth2:
              - Register an Identity Provider: admin/oauth2/create-client.md
              - Create Okta Client: admin/oauth2/create-okta-client.md
              - Create Azure Client: admin/oauth2/create-azure-client.md
          - Configure LDAP/Kerberos:
              - Configure LDAP: admin/ldap/configure-ldap.md
              - Configure Kerberos: admin/ldap/configure-krb.md
              - Configure server for LDAP and Kerberos: admin/ldap/configure-server.md
              - Configure Project Mapping: admin/ldap/configure-project-mapping.md
      - High availability / Disaster Recovery:
          - Overview: admin/ha-dr/intro.md
          - High Availability: admin/ha-dr/ha.md
          - Disaster Recovery: admin/ha-dr/dr.md
      - Audit:
          - Access Audit Logs: admin/audit/audit-logs.md
          - Export Audit Logs: admin/audit/export-audit-logs.md
  - <div class="dropdown"><button class="dropbtn"> API </button> <div id="myDropdown" class="dropdown-content"> <a id="hopsworks_api_link" href="https://docs.hopsworks.ai/hopsworks-api/3.9">Hopsworks API</a> <a id="hsfs_api_link" href="https://docs.hopsworks.ai/feature-store-api/3.9">Feature Store API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/feature-store-api/3.9/javadoc">Feature Store JavaDoc</a> <a id="hsml_api_link" href="https://docs.hopsworks.ai/machine-learning-api/3.9">MLOps API</a> </div></div>: https://docs.hopsworks.ai
  - Community ↗: https://community.hopsworks.ai/

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
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes

extra:
  hopsworks_version: 3.9
  version:
    provider: mike
    default: latest
  generator: false
  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
  analytics:
    provider: google
    property: G-64FEEXPSDN

extra_css:
  - css/custom.css
  - css/marctech.css
  - css/dropdown.css

extra_javascript:
  - js/inject-api-links.js
  - js/dropdown.js
  - js/quickstart-fullscreen.js

plugins:
  - search
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
  - mkdocs-jupyter
  - macros:
      # have to use custom templating string otherwise it interferes with jupyter notebooks
      j2_block_start_string: "{{{%"
      j2_block_end_string: "%}}}"
      j2_variable_start_string: "{{{"
      j2_variable_end_string: "}}}"
  - mike:
      canonical_version: latest

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.critic
  - attr_list
  - md_in_html
  - def_list
  - toc:
      permalink: "#"
  - pymdownx.tasklist:
      custom_checkbox: true
  - markdown_include.include:
      base_path: docs
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg