Skip to content

Remove questionable conclusions #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,3 @@ receivers:
<!channel> summary: {{ .Annotations.summary }} description: {{
.Annotations.description }}
```

## Conclusion
In this guide you learned how to configure alerts in Hopsworks.
4 changes: 2 additions & 2 deletions docs/setup_installation/admin/audit/audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/setup_installation/admin/audit/export-audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,3 @@ bq load --project_id <projectId> \

!!! 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.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/ldap/configure-krb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/setup_installation/admin/ldap/configure-ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/ldap/configure-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 1 addition & 4 deletions docs/setup_installation/admin/monitoring/export-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
6 changes: 2 additions & 4 deletions docs/setup_installation/admin/monitoring/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 2 additions & 4 deletions docs/setup_installation/admin/monitoring/services-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 0 additions & 5 deletions docs/setup_installation/admin/oauth2/create-azure-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,3 @@ Enter the *Redirect URI* and click on *Configure*. The redirect URI is *HOPSWORK
<figcaption>Configure platform: Redirect</figcaption>
</figure>
</p>


## 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_.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/oauth2/create-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/setup_installation/admin/oauth2/create-okta-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/roleChaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/setup_installation/admin/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/user_guides/fs/feature_group/data_validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 0 additions & 4 deletions docs/user_guides/fs/sharing/sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/user_guides/mlops/registry/frameworks/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
4 changes: 2 additions & 2 deletions docs/user_guides/mlops/registry/frameworks/skl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
4 changes: 2 additions & 2 deletions docs/user_guides/mlops/registry/frameworks/tf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/registry/input_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/registry/model_evaluation_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/registry/model_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/serving/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/serving/predictor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/serving/transformer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/mlops/vector_database/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/krb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,3 @@ If you miss this step, you will have to recover your smartphone credentials at a
</figure>

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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/auth/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,3 @@ After your account is created an administrator needs to validate your account be
<img width="400px" src="../../../../assets/images/auth/account-created.png" alt="Register" />
<figcaption>Account created</figcaption>
</figure>

## Conclusion
In this guide you learned how to create an account in Hopsworks.
4 changes: 2 additions & 2 deletions docs/user_guides/projects/git/clone_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
You can now start [Jupyter](../jupyter/python_notebook.md) from the cloned git repository path to work with the files.
4 changes: 2 additions & 2 deletions docs/user_guides/projects/git/configure_git_provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
You can now use the credentials to [clone a repository](clone_repo.md) from the configured provider.
3 changes: 0 additions & 3 deletions docs/user_guides/projects/iam_role/iam_role_chaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/projects/jobs/notebook_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/projects/jobs/pyspark_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/projects/jobs/python_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/user_guides/projects/jobs/spark_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/user_guides/projects/jupyter/python_notebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,6 @@ Start the Jupyter instance by clicking the `Run Jupyter` button.
</p>


## 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.
Loading