Skip to content
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
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,6 @@
# "navigation_depth": 6,
"navbar_end": ["navbar-icon-links"],
"external_links": [
{"name": "API Docs", "url": "https://app.deepchecks.com/docs"},
{"name": "Testing", "url": "https://docs.deepchecks.com/stable"},
{"name": "CI", "url": "https://docs.deepchecks.com/stable/general/usage/ci_cd.html"}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you're using the SaaS offering, feel free to skip to the :ref:`environment_se
:ref:`Monitoring Quickstart for SaaS <quick_tabular>`.

.. Don't want to manage the deepchecks app yourself? The quickest way to get started with Deepchecks is to use
.. the SaaS `Deepchecks Cloud <https://app.deepchecks.com>`__ offering.
.. the SaaS Deepchecks Cloud offering.

.. note::
The open source version is built for monitoring 1 model per deployment. Its ability to handle scale
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/environment_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Step #3: Create or join an organization

For SaaS usage: following an invite mail (sign up to our invite system at the `Deepchecks Website`_, or contact us at info@deepchecks.com),
you'll be able to join a new organization.
Then, head over to the deepchecks host URL (e.g. https://app.deepchecks.com or your unique url if received) to start exploring.
Then, head over to the deepchecks host URL (e.g. your unique url if received) to start exploring.

For open source: create a user and organization and log in to the deepchecks UI, hosted at the url you've chosen during installation
(default is http://localhost).
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user-guide/demos/plot_lending_defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@
# recommended for security reasons) copy-paste your token string here, instead of retrieving it from the environment
# variable.
token = os.getenv('DEEPCHECKS_API_TOKEN')
# Point the host to deepchecks host url (e.g. https://app.deepchecks.com. Save it to an environment variable,
# or alternatively copy-paste it here directly)
# Point the host to deepchecks host url. Save it to an environment variable,
# or alternatively copy-paste it here directly.
host = os.getenv('DEEPCHECKS_API_HOST')
# Create a DeepchecksClient with relevant credentials
dc_client = DeepchecksClient(host=host, token=token)
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user-guide/demos/plot_rent_prediction.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
# recommended for security reasons) copy-paste your token string here, instead of retrieving it from the environment
# variable.
token = os.getenv('DEEPCHECKS_API_TOKEN')
# Point the host to deepchecks host url (e.g. https://app.deepchecks.com. Save it to an environment variable,
# or alternatively copy-paste it here directly)
# Point the host to deepchecks host url. Save it to an environment variable,
# or alternatively copy-paste it here directly.
host = os.getenv('DEEPCHECKS_API_HOST')
# Create a DeepchecksClient with relevant credentials
dc_client = DeepchecksClient(host=host, token=token)
Expand Down
10 changes: 5 additions & 5 deletions docs/source/user-guide/tabular/quickstarts/plot_quickstart.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@
# Creating a model version
# ------------------------
# In order to create a model version we must first create an organization in the
# `deepchecks app <https://app.deepchecks.com/>`_. If you are using the SaaS version of Deepchecks, you can
# find the app at `https://app.deepchecks.com <https://app.deepchecks.com/>`_ and if you are using deepchecks
# deepchecks app. If you are using the SaaS version of Deepchecks, you can
# find the app at the URL provided to you, and if you are using
# :ref:`the open-source self-hosted deployment <installation__self_host_deepchecks>`
# you can find the app at your specified deployment address (by default it's http://localhost).
#
Expand All @@ -91,7 +91,7 @@

import os

# Point the host to deepchecks app. Can be either https://app.deepchecks.com or https://localhost
# Point the host to deepchecks app (e.g. https://localhost for self-hosted).
host = os.environ.get('DEEPCHECKS_API_HOST') # Replace with your host
# note to put the API token in your environment variables. Or alternatively (less recommended):
# os.environ['DEEPCHECKS_API_TOKEN'] = 'uncomment-this-line-and-insert-your-api-token-here'
Expand Down Expand Up @@ -144,7 +144,7 @@
# Dashboard Screen
# ----------------
# After creating the model version and uploading the data, we can now see the monitors within the
# `application dashboard <https://app.deepchecks.com/>`_.
# application dashboard.
# The monitors below are generated by default when a new model is created, all versions of the same model are tracked
# within the same monitor.
#
Expand All @@ -155,7 +155,7 @@
# -------------
# The data uploaded is processed in the background before being visible in the dashboard.
# In order to verify that the data was properly uploaded to the queue and see the progress of the processing
# we can go to the `models screen <https://app.deepchecks.com/configuration/models/>`_.
# we can go to the models screen.
#
# .. image:: /_static/images/quickstart/models_screen.png
# :width: 600
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/tabular/tabular_production.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Then you should create the :class:`DeepchecksClient <deepchecks_client.Deepcheck

>>> import os
>>> from deepchecks_client import DeepchecksClient
>>> host = os.environ.get('DEEPCHECKS_API_HOST') # Replace this with https://app.deepchecks.com
>>> host = os.environ.get('DEEPCHECKS_API_HOST') # Replace this with your deepchecks host URL
>>> # Make sure to put the API token in your environment variables. Or alternatively (less recommended):
>>> # os.environ['DEEPCHECKS_API_TOKEN'] = 'uncomment-this-line-and-insert-your-api-token-here'
>>> dc_client = DeepchecksClient(host=host, token=os.getenv('DEEPCHECKS_API_TOKEN'))
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/tabular/tabular_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Then you should create the :class:`DeepchecksClient (API reference) <deepchecks_

>>> import os
>>> from deepchecks_client import DeepchecksClient
>>> host = os.environ.get('DEEPCHECKS_API_HOST') # Replace this with https://app.deepchecks.com
>>> host = os.environ.get('DEEPCHECKS_API_HOST') # Replace this with your deepchecks host URL
>>> # Make sure to put the API token in your environment variables. Or alternatively (less recommended):
>>> # os.environ['DEEPCHECKS_API_TOKEN'] = 'uncomment-this-line-and-insert-your-api-token-here'
>>> dc_client = DeepchecksClient(host=host, token=os.getenv('DEEPCHECKS_API_TOKEN'))
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/user_interface/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ An example of an HTTP request payload.
"alert_name": "model: Airbnb monitor: Percent Of Nulls - Medium",
"alert_rule": "Medium - Percent Of Nulls > 0.0",
"severity": "medium",
"alert_link": "https://app.deepchecks.com/configuration/alert-rules?modelId=6&severity=medium"
"alert_link": "https://your-deepchecks-host/configuration/alert-rules?modelId=6&severity=medium"
}


Expand Down
Loading