forked from logicalclocks/logicalclocks.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
292 lines (284 loc) · 13.7 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
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: ""
nav:
- Home: index.md
- Getting Started: getting_started/quickstart.ipynb
- Tutorials:
- Fraud Batch:
- 1. Feature Groups: tutorials/fraud_batch/1_feature_groups.ipynb
- 2. Feature View: tutorials/fraud_batch/2_feature_view_creation.ipynb
- 3. Model Training: tutorials/fraud_batch/3_model_training.ipynb
- Fraud Online:
- 1. Feature Groups: tutorials/fraud_online/1_feature_groups.ipynb
- 2. Feature View: tutorials/fraud_online/2_feature_view_creation.ipynb
- 3. Model Training: tutorials/fraud_online/3_model_training.ipynb
- Concepts:
- Hopsworks Platform: concepts/hopsworks.md
- 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
- Data Validation/Stats/Alerts: concepts/fs/feature_group/fg_statistics.md
- Versioning: concepts/fs/feature_group/versioning.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
- 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/kserve.md # create, read, version
- 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
- Data Types and Schema management: user_guides/fs/feature_group/data_types.md
- Statistics: user_guides/fs/feature_group/statistics.md
- Data Validation: user_guides/fs/feature_group/data_validation.md
- Feature View:
- user_guides/fs/feature_view/index.md
- Feature View: 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
- Query: user_guides/fs/feature_view/query.md
- Transformation Functions: user_guides/fs/feature_view/transformation-function.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
- Jupyter:
- Run Spark Notebook: user_guides/projects/jupyter/spark_notebook.md
- Run Python Notebook: user_guides/projects/jupyter/python_notebook.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
- 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
- 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 Serving:
- user_guides/mlops/serving/index.md
- Deployment: user_guides/mlops/serving/deployment.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
- Vector Database: user_guides/mlops/vector_database/index.md
- Integrations:
- Overview: user_guides/integrations/setup.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
- Setup and Installation:
- AWS:
- Getting Started: setup_installation/aws/getting_started.md
- Cluster Creation: setup_installation/aws/cluster_creation.md
- EKS/ECR integration: setup_installation/aws/eks_ecr_integration.md
- Limiting Permissions: setup_installation/aws/restrictive_permissions.md
- Cluster upgrade:
- Version 2.4 or newer: setup_installation/aws/upgrade_2.4.md
- Version 2.2 or older: setup_installation/aws/upgrade.md
- Azure:
- Getting Started: setup_installation/azure/getting_started.md
- Cluster Creation: setup_installation/azure/cluster_creation.md
- AKS/ACR integration: setup_installation/azure/aks_acr_integration.md
- Limiting Permissions: setup_installation/azure/restrictive_permissions.md
- Cluster upgrade:
- 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
- Common:
- Services: setup_installation/common/services.md
- Adding and Removing workers: setup_installation/common/adding_removing_workers.md
- Autoscaling: setup_installation/common/autoscaling.md
- Scaling up: setup_installation/common/scalingup.md
- GPU support: setup_installation/common/gpu_support.md
- User management: setup_installation/common/user_management.md
- Managed RonDB: setup_installation/common/rondb.md
- Single Sign On:
- Hopsworks:
- OAuth2: setup_installation/common/sso/oauth.md
- LDAP: setup_installation/common/sso/ldap.md
# - Hopsworks.ai: setup_installation/common/sso/sso.md TODO put back when putting back sso https://github.com/logicalclocks/hopsworks-cloud/issues/3202
- 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
- Administration:
- Introduction: admin/index.md
- User Management: admin/user.md
- Configure Alerts: admin/alert.md
- Manage Services: admin/services.md
- IAM Role Chaining: admin/roleChaining.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
- High availability / Disaster Recovery:
- Overview: admin/ha-dr/intro.md
- High Availability: admin/ha-dr/ha.md
- Disaster Recovery: admin/ha-dr/dr.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/dev">Hopsworks API</a> <a id="hsfs_api_link" href="https://docs.hopsworks.ai/feature-store-api/dev">Feature Store API</a> <a id="hsml_api_link" href="https://docs.hopsworks.ai/machine-learning-api/dev">MLOps API</a> </div></div>: https://docs.hopsworks.ai/hopsworks-api/dev
- Community: https://community.hopsworks.ai/
theme:
name: material
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
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.indexes
extra:
version:
provider: mike
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/
analytics:
provider: google
# switch for new token
property: UA-85730257-4
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
- mkdocs-jupyter
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
- toc:
permalink: "#"
- pymdownx.tasklist:
custom_checkbox: true
- markdown_include.include:
base_path: docs