From 10d3e9050a493623cd137317e64c2820d1e4b07f Mon Sep 17 00:00:00 2001 From: Aleksey Veresov Date: Fri, 25 Oct 2024 09:52:26 +0200 Subject: [PATCH] Remove questionable conclusions --- docs/setup_installation/admin/alert.md | 3 --- docs/setup_installation/admin/audit/audit-logs.md | 4 ++-- docs/setup_installation/admin/audit/export-audit-logs.md | 4 ---- docs/setup_installation/admin/auth.md | 3 --- docs/setup_installation/admin/ldap/configure-krb.md | 3 --- docs/setup_installation/admin/ldap/configure-ldap.md | 4 ---- .../admin/ldap/configure-project-mapping.md | 4 ---- docs/setup_installation/admin/ldap/configure-server.md | 3 --- docs/setup_installation/admin/monitoring/export-metrics.md | 5 +---- docs/setup_installation/admin/monitoring/grafana.md | 6 ++---- docs/setup_installation/admin/monitoring/services-logs.md | 6 ++---- docs/setup_installation/admin/oauth2/create-azure-client.md | 5 ----- docs/setup_installation/admin/oauth2/create-client.md | 3 --- docs/setup_installation/admin/oauth2/create-okta-client.md | 4 ---- docs/setup_installation/admin/roleChaining.md | 3 --- docs/setup_installation/admin/services.md | 3 --- docs/setup_installation/admin/user.md | 3 --- docs/user_guides/fs/feature_group/data_validation.md | 2 +- docs/user_guides/fs/sharing/sharing.md | 4 ---- docs/user_guides/mlops/registry/frameworks/python.md | 4 ++-- docs/user_guides/mlops/registry/frameworks/skl.md | 4 ++-- docs/user_guides/mlops/registry/frameworks/tf.md | 4 ++-- docs/user_guides/mlops/registry/input_example.md | 4 ---- docs/user_guides/mlops/registry/model_evaluation_images.md | 4 ---- docs/user_guides/mlops/registry/model_schema.md | 4 ---- docs/user_guides/mlops/serving/deployment.md | 4 ---- docs/user_guides/mlops/serving/predictor.md | 4 ---- docs/user_guides/mlops/serving/transformer.md | 4 ---- docs/user_guides/mlops/vector_database/index.md | 4 ---- docs/user_guides/projects/auth/krb.md | 3 --- docs/user_guides/projects/auth/ldap.md | 3 --- docs/user_guides/projects/auth/login.md | 3 --- docs/user_guides/projects/auth/oauth.md | 3 --- docs/user_guides/projects/auth/profile.md | 3 --- docs/user_guides/projects/auth/recovery.md | 3 --- docs/user_guides/projects/auth/registration.md | 3 --- docs/user_guides/projects/git/clone_repo.md | 4 ++-- docs/user_guides/projects/git/configure_git_provider.md | 4 ++-- docs/user_guides/projects/iam_role/iam_role_chaining.md | 3 --- docs/user_guides/projects/jobs/notebook_job.md | 4 ---- docs/user_guides/projects/jobs/pyspark_job.md | 4 ---- docs/user_guides/projects/jobs/python_job.md | 4 ---- docs/user_guides/projects/jobs/spark_job.md | 4 ---- docs/user_guides/projects/jupyter/python_notebook.md | 4 ++-- .../projects/jupyter/remote_filesystem_driver.md | 4 ---- docs/user_guides/projects/jupyter/spark_notebook.md | 4 ++-- docs/user_guides/projects/kafka/consume_messages.md | 4 ---- docs/user_guides/projects/kafka/create_schema.md | 4 ---- docs/user_guides/projects/kafka/create_topic.md | 4 ---- docs/user_guides/projects/kafka/produce_messages.md | 4 ++-- docs/user_guides/projects/opensearch/connect.md | 4 ++-- docs/user_guides/projects/project/add_members.md | 4 ---- docs/user_guides/projects/project/create_project.md | 4 ---- docs/user_guides/projects/python/custom_commands.md | 5 ----- docs/user_guides/projects/python/environment_history.md | 3 --- docs/user_guides/projects/python/python_env_export.md | 4 ---- docs/user_guides/projects/python/python_install.md | 4 ++-- docs/user_guides/projects/secrets/create_secret.md | 4 ---- 58 files changed, 28 insertions(+), 192 deletions(-) diff --git a/docs/setup_installation/admin/alert.md b/docs/setup_installation/admin/alert.md index 4c9962b04..dc5a2c5e2 100644 --- a/docs/setup_installation/admin/alert.md +++ b/docs/setup_installation/admin/alert.md @@ -142,6 +142,3 @@ receivers: summary: {{ .Annotations.summary }} description: {{ .Annotations.description }} ``` - -## Conclusion -In this guide you learned how to configure alerts in Hopsworks. diff --git a/docs/setup_installation/admin/audit/audit-logs.md b/docs/setup_installation/admin/audit/audit-logs.md index b15bd391b..80258120c 100644 --- a/docs/setup_installation/admin/audit/audit-logs.md +++ b/docs/setup_installation/admin/audit/audit-logs.md @@ -66,6 +66,6 @@ Regardless the format, each line in the audit logs can contain the following var | pathInfo | the URL path called by the client | | dateTime | time of the request | -## Conclusion +## Going Further -In this guide we showed how you can configure audit logs in Hopsworks from the admin page and access the audit log files via SSH. To learn how to export audit logs, see [Export Audit Logs](../audit/export-audit-logs.md). +You can [export audit logs](../audit/export-audit-logs.md) to use them outside Hopsworks. diff --git a/docs/setup_installation/admin/audit/export-audit-logs.md b/docs/setup_installation/admin/audit/export-audit-logs.md index eb2522d7d..781937571 100644 --- a/docs/setup_installation/admin/audit/export-audit-logs.md +++ b/docs/setup_installation/admin/audit/export-audit-logs.md @@ -51,7 +51,3 @@ bq load --project_id \ !!! tip This command can be configured to run periodically on a given schedule by setting up a cronjob. - -## Conclusion - -In this guide you showed how you can export audit logs in your Hopsworks cluster to a BigQuery table. \ No newline at end of file diff --git a/docs/setup_installation/admin/auth.md b/docs/setup_installation/admin/auth.md index abedd6d7f..2d986b963 100644 --- a/docs/setup_installation/admin/auth.md +++ b/docs/setup_installation/admin/auth.md @@ -41,6 +41,3 @@ In the **Cluster Settings** _Authentication_ tab you can configure how users aut In the figure above we see a cluster with Two-factor authentication disabled, OAuth enabled with one registered identity provider and LDAP authentication enabled. - -## Conclusion -In this guide you learned how to configure authentication methods in Hopsworks. diff --git a/docs/setup_installation/admin/ldap/configure-krb.md b/docs/setup_installation/admin/ldap/configure-krb.md index cc5b20e81..2b83cc823 100644 --- a/docs/setup_installation/admin/ldap/configure-krb.md +++ b/docs/setup_installation/admin/ldap/configure-krb.md @@ -67,6 +67,3 @@ The login page will now have the choice to use Kerberos for authentication. Make sure that you have Kerberos properly configured on your computer and you are logged in. Kerberos support must also be configured on the browser to use Kerberos for authentication. - -## Conclusion -In this guide you learned how to configure Kerberos for authentication. diff --git a/docs/setup_installation/admin/ldap/configure-ldap.md b/docs/setup_installation/admin/ldap/configure-ldap.md index cda815d19..10f0c9a33 100644 --- a/docs/setup_installation/admin/ldap/configure-ldap.md +++ b/docs/setup_installation/admin/ldap/configure-ldap.md @@ -62,7 +62,3 @@ The login page will now have the choice to use LDAP for authentication. When group mapping is disabled an administrator needs to activate each user from the [User Management](../user.md) page. If group mapping is disabled then Account status in LDAP configuration above should be set to ```Verified```. - - -## Conclusion -In this guide you learned how to configure LDAP for authentication. diff --git a/docs/setup_installation/admin/ldap/configure-project-mapping.md b/docs/setup_installation/admin/ldap/configure-project-mapping.md index fdeca6231..48da1f627 100644 --- a/docs/setup_installation/admin/ldap/configure-project-mapping.md +++ b/docs/setup_installation/admin/ldap/configure-project-mapping.md @@ -85,7 +85,3 @@ After configuring all the group mappings users will be added to or removed from It is also possible to synchronize mappings without requiring users to log out. This can be done by setting ```ldap_group_mapping_sync_interval``` to an interval greater or equal to 2 minutes. If ```ldap_group_mapping_sync_interval``` is set group mapping sync will run periodically based on the interval and add or remove users from projects. - - -## Conclusion -In this guide you learned how to configure LDAP group to project mapping. diff --git a/docs/setup_installation/admin/ldap/configure-server.md b/docs/setup_installation/admin/ldap/configure-server.md index 32ab46e12..0ea08d3f1 100644 --- a/docs/setup_installation/admin/ldap/configure-server.md +++ b/docs/setup_installation/admin/ldap/configure-server.md @@ -92,6 +92,3 @@ Both Kerberos and LDAP attributes need to be specified to configure Kerberos. Th - spnego_server_conf: contains the configuration that will be appended to Payara's (application serve used to host hopsworks) login.conf. In particular, it should contain useKeyTab=true, and the principal name to be used in the authentication phase. Initiator should be set to false. - -## Conclusion -In this guide you learned how to configure the application server for LDAP and Kerberos. diff --git a/docs/setup_installation/admin/monitoring/export-metrics.md b/docs/setup_installation/admin/monitoring/export-metrics.md index 33d657545..26d10e794 100644 --- a/docs/setup_installation/admin/monitoring/export-metrics.md +++ b/docs/setup_installation/admin/monitoring/export-metrics.md @@ -3,6 +3,7 @@ ## Introduction Hopsworks services produce metrics which are centrally gathered by [Prometheus](https://prometheus.io/) and visualized in [Grafana](../grafana). Although the system is self-contained, it is possible to export these metrics to third-party services or another Prometheus instance. +This is useful if you have a centralized monitoring system with already configured alerts. ## Prerequisites In order to configure Prometheus to export metrics you need `root` SSH access to either Hopsworks or to the target server depending on the export method you choose below. @@ -76,7 +77,3 @@ remote_write: max_samples_per_send: 5000 batch_send_deadline: 60s ``` - -## Conclusion -In this guide we showed how you can push metrics outside of Hopsworks cluster using two methods, (a) federated Prometheus or (b) remote write to a custom service. This configuration is useful if you -already have a centralized monitoring system with alerts already configured. \ No newline at end of file diff --git a/docs/setup_installation/admin/monitoring/grafana.md b/docs/setup_installation/admin/monitoring/grafana.md index f915affc9..7a6d0c9c0 100644 --- a/docs/setup_installation/admin/monitoring/grafana.md +++ b/docs/setup_installation/admin/monitoring/grafana.md @@ -46,8 +46,6 @@ The default dashboards are read only and cannot be edited. Additional dashboards By default Hopsworks keeps metrics information only for the past 15 days. This means that, by default, you will not be able to access health and performance metrics which are older than 15 days. -## Conclusion +## Going Further -In this guide you learned how to access the Grafana dashboards to monitor the health and performance of the Hopsworks services. - -You can find additional documentation on Grafana itself at: [https://grafana.com/docs/](https://grafana.com/docs/) +You can read [Grafana Documentation](https://grafana.com/docs/) to learn how to use it advancedly. diff --git a/docs/setup_installation/admin/monitoring/services-logs.md b/docs/setup_installation/admin/monitoring/services-logs.md index 4ccdafab5..79a0cfef9 100644 --- a/docs/setup_installation/admin/monitoring/services-logs.md +++ b/docs/setup_installation/admin/monitoring/services-logs.md @@ -40,8 +40,6 @@ Currently only the logs of the following services are collected and indexed: Hop By default, logs are rotated automatically after 7 days. This means that by default, you will not be able to access logs through OpenSearch Dashboards which are older than 7 days. Depending on the service and on the Hopsworks configuration, you can still access the logs by SSH directly into the machines of the cluster. -## Conclusion +## Going Further -In this guide you learned how to access the services logs using OpenSearch Dashboards from the Hopsworks admin page. - -You can find additional documentation on OpenSearch Dashboards at: [https://opensearch.org/docs/latest/](https://opensearch.org/docs/latest/) +You can read [OpenSearch Dashboards Documentation](https://opensearch.org/docs/latest/dashboards/) to learn how to use them advancedly. diff --git a/docs/setup_installation/admin/oauth2/create-azure-client.md b/docs/setup_installation/admin/oauth2/create-azure-client.md index 52491a480..03cfdfde5 100644 --- a/docs/setup_installation/admin/oauth2/create-azure-client.md +++ b/docs/setup_installation/admin/oauth2/create-azure-client.md @@ -104,8 +104,3 @@ Enter the *Redirect URI* and click on *Configure*. The redirect URI is *HOPSWORK
Configure platform: Redirect

- - -## Conclusion -In this guide you learned how to create a client in your Azure identity provider and -acquire a _client id_ and a _client secret_. diff --git a/docs/setup_installation/admin/oauth2/create-client.md b/docs/setup_installation/admin/oauth2/create-client.md index 8199a545c..b455c68f4 100644 --- a/docs/setup_installation/admin/oauth2/create-client.md +++ b/docs/setup_installation/admin/oauth2/create-client.md @@ -71,6 +71,3 @@ redirect to your identity provider. endpoint of the provider. The well-known URL, will typically be the _Connection URL_ plus `.well-known/openid-configuration`. For the above client it would be `https://dev-86723251.okta.com/.well-known/openid-configuration`. - -## Conclusion -In this guide you learned how to register an identity provider in Hopsworks. diff --git a/docs/setup_installation/admin/oauth2/create-okta-client.md b/docs/setup_installation/admin/oauth2/create-okta-client.md index 9eea97c62..6fb7f1d10 100644 --- a/docs/setup_installation/admin/oauth2/create-okta-client.md +++ b/docs/setup_installation/admin/oauth2/create-okta-client.md @@ -66,7 +66,3 @@ _Okta domain_ (_Connection URL_), _client id_ and _client secret_ generated for When copying the domain in the figure above make sure to add the url scheme (http:// or https://) when using it in the _Connection URL_ in the [Identity Provider registration form](../create-client). - -## Conclusion -In this guide you learned how to create a client in your Okta identity provider and -acquire a _client id_ and a _client secret_. diff --git a/docs/setup_installation/admin/roleChaining.md b/docs/setup_installation/admin/roleChaining.md index a4a76c624..ae6d5caec 100644 --- a/docs/setup_installation/admin/roleChaining.md +++ b/docs/setup_installation/admin/roleChaining.md @@ -79,6 +79,3 @@ Add mappings by clicking on *New role chaining*. Enter the project name. Select Project member can now create connectors using *temporary credentials* to assume the role you configured. More detail about using temporary credentials can be found [here](../../user_guides/fs/storage_connector/creation/s3.md#temporary-credentials). Project member can see the list of role they can assume by going the _Project Settings_ -> [Assuming IAM Roles](../../../user_guides/projects/iam_role/iam_role_chaining) page. - -## Conclusion -In this guide you learned how to configure and map AWS IAM roles to project roles in Hopsworks. diff --git a/docs/setup_installation/admin/services.md b/docs/setup_installation/admin/services.md index e5de44fa4..7c8addb6a 100644 --- a/docs/setup_installation/admin/services.md +++ b/docs/setup_installation/admin/services.md @@ -44,6 +44,3 @@ After you find the correct service you will be able to **start**, **stop** or ** Stopping some services like the web server (glassfish_domain1) is not recommended. If you stop it you will have to access the machine running the service and start it with ```systemctl start glassfish_domain1```. - -## Conclusion -In this guide you learned how to manage services in Hopsworks. diff --git a/docs/setup_installation/admin/user.md b/docs/setup_installation/admin/user.md index d394bb04d..4539bb17a 100644 --- a/docs/setup_installation/admin/user.md +++ b/docs/setup_installation/admin/user.md @@ -113,6 +113,3 @@ A user with a temporary password will see a warning message when going to _Accou !!! Note A temporary password should be changed as soon as possible. - -## Conclusion -In this guide you learned how to manage users in Hopsworks. diff --git a/docs/user_guides/fs/feature_group/data_validation.md b/docs/user_guides/fs/feature_group/data_validation.md index 1e5d8886a..84402694a 100644 --- a/docs/user_guides/fs/feature_group/data_validation.md +++ b/docs/user_guides/fs/feature_group/data_validation.md @@ -212,6 +212,6 @@ You can find the expectationIds in the UI or using `fg.get_expectation_suite` an The integration between Hopsworks and Great Expectations makes it simple to add a data validation step to your feature engineering pipeline. Build your Expectation Suite and attach it to your Feature Group with a single line of code. No need to add any code to your pipeline or job scripts, calling `fg.insert` will now automatically validate the data before inserting them in the Feature Group. The validation reports are stored along your data in Hopsworks allowing us to provide basic monitoring capabilities to quickly spot a data quality issue in the UI. -## Going further +## Going Further If you wish to find out more about how to use the data validation API or best practices for development or production pipelines in Hopsworks, checkout the [advanced guide](data_validation_advanced.md) and [best practices guide](data_validation_best_practices.md). diff --git a/docs/user_guides/fs/sharing/sharing.md b/docs/user_guides/fs/sharing/sharing.md index b9b2773f2..9fcf04a9b 100644 --- a/docs/user_guides/fs/sharing/sharing.md +++ b/docs/user_guides/fs/sharing/sharing.md @@ -92,7 +92,3 @@ fg_a = project_feature_store.get_or_create_feature_group( # join above feature groups query = shared_fg.select_all().join(fg_a.select_all()) ``` - -## Conclusion - -In this guide, you learned how to share a feature store and how to join features from different feature stores. diff --git a/docs/user_guides/mlops/registry/frameworks/python.md b/docs/user_guides/mlops/registry/frameworks/python.md index f0805f448..3895a804b 100644 --- a/docs/user_guides/mlops/registry/frameworks/python.md +++ b/docs/user_guides/mlops/registry/frameworks/python.md @@ -57,6 +57,6 @@ py_model.save(model_dir) ``` -## Conclusion +## Going Further -In this guide you learned how to export a Python model to the Model Registry. You can also try attaching an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. \ No newline at end of file +You can attach an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. diff --git a/docs/user_guides/mlops/registry/frameworks/skl.md b/docs/user_guides/mlops/registry/frameworks/skl.md index 579c26cff..9dbcb8991 100644 --- a/docs/user_guides/mlops/registry/frameworks/skl.md +++ b/docs/user_guides/mlops/registry/frameworks/skl.md @@ -56,6 +56,6 @@ skl_model.save(model_file) ``` -## Conclusion +## Going Further -In this guide you learned how to export a Scikit-learn model to the Model Registry. You can also try attaching an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. \ No newline at end of file +You can attach an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. diff --git a/docs/user_guides/mlops/registry/frameworks/tf.md b/docs/user_guides/mlops/registry/frameworks/tf.md index ade273f69..afcdacec6 100644 --- a/docs/user_guides/mlops/registry/frameworks/tf.md +++ b/docs/user_guides/mlops/registry/frameworks/tf.md @@ -67,6 +67,6 @@ tf_model.save(model_dir) ``` -## Conclusion +## Going Further -In this guide you learned how to export a TensorFlow model to the Model Registry. You can also try attaching an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. \ No newline at end of file +You can attach an [Input Example](../input_example.md) and a [Model Schema](../input_example.md) to your model to document the shape and type of the data the model was trained on. diff --git a/docs/user_guides/mlops/registry/input_example.md b/docs/user_guides/mlops/registry/input_example.md index 40325faaf..008d73da9 100644 --- a/docs/user_guides/mlops/registry/input_example.md +++ b/docs/user_guides/mlops/registry/input_example.md @@ -42,7 +42,3 @@ model = mr.tensorflow.create_model(name="mnist", model.save("./model") ``` - -## Conclusion - -In this guide you learned how to attach an input example to your model. \ No newline at end of file diff --git a/docs/user_guides/mlops/registry/model_evaluation_images.md b/docs/user_guides/mlops/registry/model_evaluation_images.md index 421515b94..4202f4630 100644 --- a/docs/user_guides/mlops/registry/model_evaluation_images.md +++ b/docs/user_guides/mlops/registry/model_evaluation_images.md @@ -73,7 +73,3 @@ fig.savefig(model_images_dir + "/confusion_matrix.png") py_model = mr.python.create_model(name="py_model") py_model.save("./model") ``` - -## Conclusion - -In this guide you learned how to attach model evaluation images to a model, visually communicating the model performance and evaluation metrics in the model registry. \ No newline at end of file diff --git a/docs/user_guides/mlops/registry/model_schema.md b/docs/user_guides/mlops/registry/model_schema.md index b736c09ea..389ff78ab 100644 --- a/docs/user_guides/mlops/registry/model_schema.md +++ b/docs/user_guides/mlops/registry/model_schema.md @@ -58,7 +58,3 @@ model = mr.tensorflow.create_model(name="mnist", model.save("./model") ``` - -## Conclusion - -In this guide you learned how to attach an input example to your model. \ No newline at end of file diff --git a/docs/user_guides/mlops/serving/deployment.md b/docs/user_guides/mlops/serving/deployment.md index fc6b10b43..f8c5dad72 100644 --- a/docs/user_guides/mlops/serving/deployment.md +++ b/docs/user_guides/mlops/serving/deployment.md @@ -202,7 +202,3 @@ Resources include the number of replicas for the deployment as well as the resou ## API protocol Hopsworks supports both REST and gRPC as the API protocols to send inference requests to model deployments. In general, you use gRPC when you need lower latency inference requests. To learn more about the REST and gRPC API protocols for model deployments, see the [API Protocol Guide](api-protocol.md). - -## Conclusion - -In this guide you learned how to create a deployment. \ No newline at end of file diff --git a/docs/user_guides/mlops/serving/predictor.md b/docs/user_guides/mlops/serving/predictor.md index 6d2830005..9da0792b6 100644 --- a/docs/user_guides/mlops/serving/predictor.md +++ b/docs/user_guides/mlops/serving/predictor.md @@ -276,7 +276,3 @@ Resources include the number of replicas for the deployment as well as the resou ## API protocol Hopsworks supports both REST and gRPC as the API protocols to send inference requests to model deployments. In general, you use gRPC when you need lower latency inference requests. To learn more about the REST and gRPC API protocols for model deployments, see the [API Protocol Guide](api-protocol.md). - -## Conclusion - -In this guide you learned how to configure a predictor. diff --git a/docs/user_guides/mlops/serving/transformer.md b/docs/user_guides/mlops/serving/transformer.md index 2f1313c98..97298602f 100644 --- a/docs/user_guides/mlops/serving/transformer.md +++ b/docs/user_guides/mlops/serving/transformer.md @@ -176,7 +176,3 @@ A number of different environment variables is available in the transformer to e | MODEL_NAME | Name of the model being served by the current deployment | | MODEL_VERSION | Version of the model being served by the current deployment | | ARTIFACT_VERSION | Version of the model artifact being served by the current deployment | - -## Conclusion - -In this guide you learned how to configure a transformer. \ No newline at end of file diff --git a/docs/user_guides/mlops/vector_database/index.md b/docs/user_guides/mlops/vector_database/index.md index 6af72ed9e..5e9de0455 100644 --- a/docs/user_guides/mlops/vector_database/index.md +++ b/docs/user_guides/mlops/vector_database/index.md @@ -162,7 +162,3 @@ pp.pprint(response) [k-NN plugin](https://opensearch.org/docs/1.3/search-plugins/knn/knn-index/) [OpenSearch](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/open_search/) - -## Conclusion - -In this guide you learned how to create a simple recommendation application. \ No newline at end of file diff --git a/docs/user_guides/projects/auth/krb.md b/docs/user_guides/projects/auth/krb.md index a0f90abb6..7498bce19 100644 --- a/docs/user_guides/projects/auth/krb.md +++ b/docs/user_guides/projects/auth/krb.md @@ -54,6 +54,3 @@ After clicking on **Register** you will be redirected to the landing page: In the landing page, you will find two buttons. Use these buttons to either create a _demo project_ or [a new project](../../../projects/project/create_project). - -## Conclusion -In this guide you learned how to log in to Hopsworks using Kerberos. diff --git a/docs/user_guides/projects/auth/ldap.md b/docs/user_guides/projects/auth/ldap.md index b79f878d0..aedf1bf23 100644 --- a/docs/user_guides/projects/auth/ldap.md +++ b/docs/user_guides/projects/auth/ldap.md @@ -38,6 +38,3 @@ After clicking on **Register** you will be redirected to the landing page: In the landing page, you will find two buttons. Use these buttons to either create a _demo project_ or [a new project](../../../projects/project/create_project). - -## Conclusion -In this guide you learned how to log in to Hopsworks using LDAP. diff --git a/docs/user_guides/projects/auth/login.md b/docs/user_guides/projects/auth/login.md index c5087fe70..c0bf4c4c4 100644 --- a/docs/user_guides/projects/auth/login.md +++ b/docs/user_guides/projects/auth/login.md @@ -35,6 +35,3 @@ Upon successful login, you will arrive at the landing page: In the landing page, you will find two buttons. Use these buttons to either create a _demo project_ or [a new project](../../../projects/project/create_project). - -## Conclusion -In this guide you learned how to log in to Hopsworks. diff --git a/docs/user_guides/projects/auth/oauth.md b/docs/user_guides/projects/auth/oauth.md index 4c52f16ec..8d7a52a23 100644 --- a/docs/user_guides/projects/auth/oauth.md +++ b/docs/user_guides/projects/auth/oauth.md @@ -33,6 +33,3 @@ After clicking on **Register** you will be redirected to the landing page: In the landing page, you will find two buttons. Use these buttons to either create a _demo project_ or [a new project](../../../projects/project/create_project). - -## Conclusion -In this guide you learned how to log in to Hopsworks using Third-party Identity Provider. diff --git a/docs/user_guides/projects/auth/profile.md b/docs/user_guides/projects/auth/profile.md index 96a81fb78..194f2d3c2 100644 --- a/docs/user_guides/projects/auth/profile.md +++ b/docs/user_guides/projects/auth/profile.md @@ -48,6 +48,3 @@ If you miss this step, you will have to recover your smartphone credentials at a Use the one time password generated by your authenticator app to confirm the registration. - -## Conclusion -In this guide you learned how to edit your profile and credentials. \ No newline at end of file diff --git a/docs/user_guides/projects/auth/recovery.md b/docs/user_guides/projects/auth/recovery.md index 2d0c648b0..2d36d30c5 100644 --- a/docs/user_guides/projects/auth/recovery.md +++ b/docs/user_guides/projects/auth/recovery.md @@ -17,6 +17,3 @@ If you forget your password start by clicking on **Forgot password** on the logi ### Step 2: Use the password reset link A password reset link will be sent to the email address you entered if the email is found in the system. Click on the reset link to set your new password. - -## Conclusion -In this guide you learned how to recover your password. \ No newline at end of file diff --git a/docs/user_guides/projects/auth/registration.md b/docs/user_guides/projects/auth/registration.md index f2cb45385..67db5f857 100644 --- a/docs/user_guides/projects/auth/registration.md +++ b/docs/user_guides/projects/auth/registration.md @@ -38,6 +38,3 @@ After your account is created an administrator needs to validate your account be Register
Account created
- -## Conclusion -In this guide you learned how to create an account in Hopsworks. \ No newline at end of file diff --git a/docs/user_guides/projects/git/clone_repo.md b/docs/user_guides/projects/git/clone_repo.md index cfa63c996..8189ca3e1 100644 --- a/docs/user_guides/projects/git/clone_repo.md +++ b/docs/user_guides/projects/git/clone_repo.md @@ -112,6 +112,6 @@ Cloning a large repo or checking out a large branch may hit timeout errors. You ### Symlink errors Git repositories with symlinks are not yet supported, therefore cloning repositories with symlinks will fail. You can create a separate branch to remove the symlinks, and clone from this branch. -## Conclusion +## Going Further -In this guide you learned how to clone a Git repository. You can now start [Jupyter](../jupyter/python_notebook.md) from the cloned git repository path to work with the files. \ No newline at end of file +You can now start [Jupyter](../jupyter/python_notebook.md) from the cloned git repository path to work with the files. diff --git a/docs/user_guides/projects/git/configure_git_provider.md b/docs/user_guides/projects/git/configure_git_provider.md index 94e554d79..44966274e 100644 --- a/docs/user_guides/projects/git/configure_git_provider.md +++ b/docs/user_guides/projects/git/configure_git_provider.md @@ -82,6 +82,6 @@ git_api.set_provider(PROVIDER, GITHUB_USER, API_TOKEN) [GitProvider](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/git_provider/) -## Conclusion +## Going Further -In this guide you learned how configure your git provider credentials. You can now use the credentials to [clone a repository](clone_repo.md) from the configured provider. \ No newline at end of file +You can now use the credentials to [clone a repository](clone_repo.md) from the configured provider. diff --git a/docs/user_guides/projects/iam_role/iam_role_chaining.md b/docs/user_guides/projects/iam_role/iam_role_chaining.md index 0f70a5fc1..7fd0df3cd 100644 --- a/docs/user_guides/projects/iam_role/iam_role_chaining.md +++ b/docs/user_guides/projects/iam_role/iam_role_chaining.md @@ -27,6 +27,3 @@ In the _Project Settings_ page you can find the _IAM Role Chaining_ section show ### Step 2: Use the IAM role You can now use the IAM roles listed in your project when creating a storage connector with [Temporary Credentials](../../../fs/storage_connector/creation/s3/#temporary-credentials). - -## Conclusion -In this guide you learned how to use IAM roles on a cluster deployed on an EC2 instances. diff --git a/docs/user_guides/projects/jobs/notebook_job.md b/docs/user_guides/projects/jobs/notebook_job.md index 5c5280d9a..a17788651 100644 --- a/docs/user_guides/projects/jobs/notebook_job.md +++ b/docs/user_guides/projects/jobs/notebook_job.md @@ -171,7 +171,3 @@ execution = job.run(args='-p a 2 -p b 5', await_termination=True) [Jobs](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/jobs/) [Executions](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/executions/) - -## Conclusion - -In this guide you learned how to create and run a Jupyter Notebook job. \ No newline at end of file diff --git a/docs/user_guides/projects/jobs/pyspark_job.md b/docs/user_guides/projects/jobs/pyspark_job.md index 62255d157..3cc9e3030 100644 --- a/docs/user_guides/projects/jobs/pyspark_job.md +++ b/docs/user_guides/projects/jobs/pyspark_job.md @@ -216,7 +216,3 @@ print(f_err.read()) [Jobs](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/jobs/) [Executions](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/executions/) - -## Conclusion - -In this guide you learned how to create and run a PySpark job. \ No newline at end of file diff --git a/docs/user_guides/projects/jobs/python_job.md b/docs/user_guides/projects/jobs/python_job.md index 5ef734610..4fa58cfa6 100644 --- a/docs/user_guides/projects/jobs/python_job.md +++ b/docs/user_guides/projects/jobs/python_job.md @@ -168,7 +168,3 @@ print(f_err.read()) [Jobs](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/jobs/) [Executions](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/executions/) - -## Conclusion - -In this guide you learned how to create and run a Python job. \ No newline at end of file diff --git a/docs/user_guides/projects/jobs/spark_job.md b/docs/user_guides/projects/jobs/spark_job.md index a6afbc41f..66be8c001 100644 --- a/docs/user_guides/projects/jobs/spark_job.md +++ b/docs/user_guides/projects/jobs/spark_job.md @@ -217,7 +217,3 @@ print(f_err.read()) [Jobs](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/jobs/) [Executions](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/executions/) - -## Conclusion - -In this guide you learned how to create and run a Spark job. \ No newline at end of file diff --git a/docs/user_guides/projects/jupyter/python_notebook.md b/docs/user_guides/projects/jupyter/python_notebook.md index 96776e597..3412a0d96 100644 --- a/docs/user_guides/projects/jupyter/python_notebook.md +++ b/docs/user_guides/projects/jupyter/python_notebook.md @@ -83,6 +83,6 @@ Start the Jupyter instance by clicking the `Run Jupyter` button.

-## Conclusion +## Going Further -In this guide you learned how to configure and run a Python application in Jupyter. You can now follow this [guide](../python/python_install.md) to install a library that can be used in a notebook. +You can learn how to [install a library](../python/python_install.md) so that it can be used in a notebook. diff --git a/docs/user_guides/projects/jupyter/remote_filesystem_driver.md b/docs/user_guides/projects/jupyter/remote_filesystem_driver.md index c6dc3fa02..3d55a24dc 100644 --- a/docs/user_guides/projects/jupyter/remote_filesystem_driver.md +++ b/docs/user_guides/projects/jupyter/remote_filesystem_driver.md @@ -12,7 +12,3 @@ We provide two ways to access and persist files in HopsFS from a jupyter noteboo ## Configuring the driver To configure the driver you need to have admin role and set the `jupyter_remote_fs_driver` to either `hdfscontentsmanager` or `hopsfsmount`. The default driver is `hdfscontentsmanager`. - -## Conclusion - -In this guide you learned about the filesystem drivers for jupyter notebooks and how to configure them. diff --git a/docs/user_guides/projects/jupyter/spark_notebook.md b/docs/user_guides/projects/jupyter/spark_notebook.md index b5787e3e4..3209d8ee7 100644 --- a/docs/user_guides/projects/jupyter/spark_notebook.md +++ b/docs/user_guides/projects/jupyter/spark_notebook.md @@ -134,6 +134,6 @@ Navigate back to Hopsworks and a Spark session will have appeared, click on the

-## Conclusion +## Going Further -In this guide you learned how to configure and run a Spark application in Jupyter. You can now follow this [guide](../python/python_install.md) to install a library that can be used in a notebook. +You can learn how to [install a library](../python/python_install.md) so that it can be used in a notebook. diff --git a/docs/user_guides/projects/kafka/consume_messages.md b/docs/user_guides/projects/kafka/consume_messages.md index 40e275553..3ae01aa76 100644 --- a/docs/user_guides/projects/kafka/consume_messages.md +++ b/docs/user_guides/projects/kafka/consume_messages.md @@ -53,7 +53,3 @@ for i in range(0, 10): ### API Reference [KafkaTopic](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/kafka_topic/) - -## Conclusion - -In this guide you learned how to consume messages from a Kafka Topic. diff --git a/docs/user_guides/projects/kafka/create_schema.md b/docs/user_guides/projects/kafka/create_schema.md index f90cf863d..a3aa204a7 100644 --- a/docs/user_guides/projects/kafka/create_schema.md +++ b/docs/user_guides/projects/kafka/create_schema.md @@ -61,7 +61,3 @@ my_schema = kafka_api.create_schema(SCHEMA_NAME, schema) ### API Reference [KafkaSchema](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/kafka_schema/) - -## Conclusion - -In this guide you learned how to create a Kafka Schema. \ No newline at end of file diff --git a/docs/user_guides/projects/kafka/create_topic.md b/docs/user_guides/projects/kafka/create_topic.md index 900e70e33..afa4b8411 100644 --- a/docs/user_guides/projects/kafka/create_topic.md +++ b/docs/user_guides/projects/kafka/create_topic.md @@ -39,7 +39,3 @@ my_topic = kafka_api.create_topic(TOPIC_NAME, SCHEMA_NAME, 1, replicas=1, partit ### API Reference [KafkaTopic](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/kafka_topic/) - -## Conclusion - -In this guide you learned how to create a Kafka Topic. diff --git a/docs/user_guides/projects/kafka/produce_messages.md b/docs/user_guides/projects/kafka/produce_messages.md index 92809d852..602ac150c 100644 --- a/docs/user_guides/projects/kafka/produce_messages.md +++ b/docs/user_guides/projects/kafka/produce_messages.md @@ -56,6 +56,6 @@ producer.flush(10) [KafkaTopic](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/kafka_topic/) -## Conclusion +## Going Further -In this guide you learned how to produce messages to a Kafka Topic. Next step is to create a [Consumer](consume_messages.md) to read the messages from the topic. +Now you can create a [Consumer](consume_messages.md) to read the messages from the topic. diff --git a/docs/user_guides/projects/opensearch/connect.md b/docs/user_guides/projects/opensearch/connect.md index 290fee70f..1e6f9f2ad 100644 --- a/docs/user_guides/projects/opensearch/connect.md +++ b/docs/user_guides/projects/opensearch/connect.md @@ -38,6 +38,6 @@ client = OpenSearch(**opensearch_api.get_default_py_config()) [OpenSearch](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/opensearch/) -## Conclusion +## Going Further -In this guide you learned how to connect to the OpenSearch cluster. You can now use the client to interact directly with the OpenSearch cluster, such as [vector database](../../mlops/vector_database/index.md). +You can now use the client to interact directly with the OpenSearch cluster, such as [vector database](../../mlops/vector_database/index.md). diff --git a/docs/user_guides/projects/project/add_members.md b/docs/user_guides/projects/project/add_members.md index 221f86e1b..811965e88 100644 --- a/docs/user_guides/projects/project/add_members.md +++ b/docs/user_guides/projects/project/add_members.md @@ -57,7 +57,3 @@ The invited user will now appear in the list of members and will have access to
List of project members

- -## Conclusion - -In this guide, you learned how to add a new member and the types of roles this member can be a part of. diff --git a/docs/user_guides/projects/project/create_project.md b/docs/user_guides/projects/project/create_project.md index 816ae73b8..7a3fa5664 100644 --- a/docs/user_guides/projects/project/create_project.md +++ b/docs/user_guides/projects/project/create_project.md @@ -93,7 +93,3 @@ INTEGER, PRECISION, VIEWS, TIME, NUMERIC, SYNC, BASE, PYTHON37, FILEBEAT. And any word containing _FEATURESTORE. ``` - -## Conclusion - -In this guide you learned how to create a project. diff --git a/docs/user_guides/projects/python/custom_commands.md b/docs/user_guides/projects/python/custom_commands.md index 39e8dff1a..a74e69753 100644 --- a/docs/user_guides/projects/python/custom_commands.md +++ b/docs/user_guides/projects/python/custom_commands.md @@ -43,8 +43,3 @@ There are few important things to be aware of when writing the bash script: * You can use `apt`, `apt-get` and `deb` commands to install packages. You should always run these commands with `sudo`. In some cases, these commands will ask for user input, therefore you should provide the input of what the command expects, e.g., `sudo apt -y install`, otherwise the build will fail. We have already configured `apt-get` to be non-interactive * The build artifacts will be copied to `srv/hops/build`. You can use them in your script via this path. This path is also available via the environmental variable `BUILD_PATH`. If you want to use many artifacts it is advisable to create a zip file and upload it to HopsFS in one of your project datasets. You can then include the zip file as one of the artifacts. * The conda environment is located in `/srv/hops/anaconda/envs/hopsworks_environment`. You can install or uninstall packages in the conda environment using pip like: `/srv/hops/anaconda/envs/hopsworks_environment/bin/pip install spotify==0.10.2`. If the command requires some input, write the command together with the expected input otherwise the build will fail. - - -## Conclusion - -In this guide you have learned how to add extra configuration to your python environment by running custom commands. \ No newline at end of file diff --git a/docs/user_guides/projects/python/environment_history.md b/docs/user_guides/projects/python/environment_history.md index 2f72ba672..e7f72bebe 100644 --- a/docs/user_guides/projects/python/environment_history.md +++ b/docs/user_guides/projects/python/environment_history.md @@ -21,6 +21,3 @@ If you had built the environment using custom commands you can go back to see wh
Figure 2: You can see custom commands that were used to create the environment by clicking on the button pointed.

- -# Conclusion -In this guide, you have learned how you can track the changes of your Python environment. diff --git a/docs/user_guides/projects/python/python_env_export.md b/docs/user_guides/projects/python/python_env_export.md index 0ca31f468..177805c0b 100644 --- a/docs/user_guides/projects/python/python_env_export.md +++ b/docs/user_guides/projects/python/python_env_export.md @@ -24,7 +24,3 @@ An existing Anaconda environment can be exported as a yml file, clicking the `Ex
Export environment

- -## Conclusion - -In this guide you learned how to export your python environment. \ No newline at end of file diff --git a/docs/user_guides/projects/python/python_install.md b/docs/user_guides/projects/python/python_install.md index a59e1394b..d7510133a 100644 --- a/docs/user_guides/projects/python/python_install.md +++ b/docs/user_guides/projects/python/python_install.md @@ -86,6 +86,6 @@ In the case of a private git repository, also select whether it is a GitHub or G

-## Conclusion +## Going Further -In this guide you learned how to install python libraries. Now you can use the library in a [Jupyter notebook](../jupyter/python_notebook.md) or a [Job](../jobs/python_job.md). +Now you can use the library in a [Jupyter notebook](../jupyter/python_notebook.md) or a [Job](../jobs/python_job.md). diff --git a/docs/user_guides/projects/secrets/create_secret.md b/docs/user_guides/projects/secrets/create_secret.md index 395e73873..bfba15025 100644 --- a/docs/user_guides/projects/secrets/create_secret.md +++ b/docs/user_guides/projects/secrets/create_secret.md @@ -65,7 +65,3 @@ secret = secrets_api.create_secret("my_secret", "Fk3MoPlQXCQvPo") ### API Reference [Secrets](https://docs.hopsworks.ai/hopsworks-api/{{{ hopsworks_version }}}/generated/api/secrets/) - -## Conclusion - -In this guide you learned how to create a secret. \ No newline at end of file