Skip to content

Commit 0987cc8

Browse files
authored
[HWORKS-2099] Remove references to hopsworks connection from the docs (#513) (#514)
1 parent c84c480 commit 0987cc8

File tree

3 files changed

+6
-27
lines changed

3 files changed

+6
-27
lines changed

docs/templates/api/connection.md

-11
This file was deleted.

mkdocs.yml

-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ nav:
1818
- API<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/latest">Hopsworks API</a> <a id="hsfs_javadoc_link" href="https://docs.hopsworks.ai/hopsworks-api/latest/javadoc">Feature Store JavaDoc</a> </div></div>:
1919
- Login: generated/api/login.md
2020
- Platform API:
21-
- Connection: generated/api/connection.md
2221
- Datasets: generated/api/datasets.md
2322
- Environment: generated/api/environment.md
2423
- Executions: generated/api/executions.md

python/auto_doc.py

+6-15
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,6 @@
4040
"api/udf.md": {
4141
"udf": ["hopsworks.udf"],
4242
},
43-
"api/connection.md": {
44-
"connection": ["hopsworks.connection.Connection.connection"],
45-
"connection_properties": keras_autodoc.get_properties(
46-
"hopsworks.connection.Connection"
47-
),
48-
"connection_methods": keras_autodoc.get_methods(
49-
"hopsworks.connection.Connection", exclude=EXCLUDE_METHODS
50-
),
51-
},
5243
"api/projects.md": {
5344
"project_create": ["hopsworks.create_project"],
5445
"project_properties": keras_autodoc.get_properties("hopsworks.project.Project"),
@@ -278,7 +269,7 @@
278269
},
279270
"api/feature_store_api.md": {
280271
"fs": ["hsfs.feature_store.FeatureStore"],
281-
"fs_get": ["hsfs.connection.Connection.get_feature_store"],
272+
"fs_get": ["hopsworks.project.Project.get_feature_store"],
282273
"fs_properties": keras_autodoc.get_properties(
283274
"hsfs.feature_store.FeatureStore"
284275
),
@@ -549,7 +540,7 @@
549540
},
550541
# Model registry
551542
"model-registry/model_registry_api.md": {
552-
"mr_get": ["hsml.connection.Connection.get_model_registry"],
543+
"mr_get": ["hopsworks.project.Project.get_model_registry"],
553544
"mr_modules": keras_autodoc.get_properties(
554545
"hsml.model_registry.ModelRegistry",
555546
exclude=[
@@ -602,7 +593,7 @@
602593
},
603594
# Model Serving
604595
"model-serving/model_serving_api.md": {
605-
"ms_get": ["hsml.connection.Connection.get_model_serving"],
596+
"ms_get": ["hopsworks.project.Project.get_model_serving"],
606597
"ms_properties": keras_autodoc.get_properties(
607598
"hsml.model_serving.ModelServing"
608599
),
@@ -611,7 +602,7 @@
611602
),
612603
},
613604
"model-serving/deployment_api.md": {
614-
"ms_get_model_serving": ["hsml.connection.Connection.get_model_serving"],
605+
"ms_get_model_serving": ["hopsworks.project.Project.get_model_serving"],
615606
"ms_get_deployments": [
616607
"hsml.model_serving.ModelServing.get_deployment",
617608
"hsml.model_serving.ModelServing.get_deployment_by_id",
@@ -626,7 +617,7 @@
626617
),
627618
},
628619
"model-serving/predictor_api.md": {
629-
"ms_get_model_serving": ["hsml.connection.Connection.get_model_serving"],
620+
"ms_get_model_serving": ["hopsworks.project.Project.get_model_serving"],
630621
"ms_create_predictor": ["hsml.model_serving.ModelServing.create_predictor"],
631622
"pred_properties": keras_autodoc.get_properties("hsml.predictor.Predictor"),
632623
"pred_methods": keras_autodoc.get_methods(
@@ -635,7 +626,7 @@
635626
),
636627
},
637628
"model-serving/transformer_api.md": {
638-
"ms_get_model_serving": ["hsml.connection.Connection.get_model_serving"],
629+
"ms_get_model_serving": ["hopsworks.project.Project.get_model_serving"],
639630
"ms_create_transformer": ["hsml.model_serving.ModelServing.create_transformer"],
640631
"trans_properties": keras_autodoc.get_properties(
641632
"hsml.transformer.Transformer"

0 commit comments

Comments
 (0)