Nb/docs/small fixes (#2589)

* removed alpha for nlp
deepchecks · Jun 8, 2023 · a26f5cb · a26f5cb
1 parent 8cf5507
commit a26f5cb
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 19 deletions.
diff --git a/docs/source/general/concepts/when_should_you_use.rst b/docs/source/general/concepts/when_should_you_use.rst
@@ -22,8 +22,9 @@ Built-In Suites - API Reference
 ================================
 
 Check the :mod:`deepchecks.tabular.suites` in the API reference for a list of all of the built-in suites for tabular data,
-:mod:`deepchecks.vision.suites` for vision data (in beta release) or
-:mod:`deepchecks.nlp.suites` for nlp data (in alpha release).
+:mod:`deepchecks.nlp.suites` for nlp data or
+:mod:`deepchecks.vision.suites` for vision data (in beta release).
+.
 
 
 Typical Validation Scenarios

diff --git a/docs/source/getting-started/welcome.rst b/docs/source/getting-started/welcome.rst
@@ -65,21 +65,21 @@ Get Started with Deepchecks Testing
         Quickstarts, main concepts, checks gallery and end-to-end guides demonstrating 
         how to start working Deepchecks with tabular data and models.
 
+    .. grid-item-card:: 🔤️ NLP 🔤️
+        :link-type: ref
+        :link: nlp__index
+
+        Quickstarts, main concepts, checks gallery and end-to-end guides demonstrating
+        how to start working Deepchecks with textual data.
+        Future releases to come!
+
     .. grid-item-card:: 🎦‍ Computer Vision (Note: in Beta Release) 🎦‍
         :link-type: ref
         :link: vision__index
 
         Quickstarts, main concepts, checks gallery and end-to-end guides demonstrating 
         how to start working Deepchecks with CV data and models.
         Built-in support for PyTorch, TensorFlow, and custom frameworks.
-
-    .. grid-item-card:: 🔤️ NLP (Note: in Alpha Release) 🔤️
-        :link-type: ref
-        :link: nlp__index
-
-        Quickstarts, main concepts, checks gallery and end-to-end guides demonstrating 
-        how to start working Deepchecks with textual data.
-        Future releases to come!
 
     .. grid-item-card:: 🚀 Interactive Checks Demo 🚀
         :link-type: url

diff --git a/docs/source/nlp/index.rst b/docs/source/nlp/index.rst
@@ -4,12 +4,12 @@
 NLP
 ===
 
-Deepchecks for NLP is currently in alpha.
-Jump over to the :ref:`nlp__quickstarts` in the Tutorials section to get started, 
+Deepchecks NLP sub package contain a large variety of checks and suites for different use cases.
+Jump over to the :ref:`nlp__quickstarts` in the Tutorials section to get started,
 or visit the :ref:`getting-started__installation` for a full 
 guide about how to set up your environment.
 
-This is an alpha release and you can help us develop it further! You can provide feedback and suggestions as issues on
+Help us develop it further! You can provide feedback and suggestions as issues on
 `GitHub <https://github.com/deepchecks/deepchecks/issues>`__, or by joining our
 `Community Slack <https://www.deepchecks.com/slack>`__.
 

diff --git a/docs/source/nlp/tutorials/quickstarts/plot_multi_label_classification.py b/docs/source/nlp/tutorials/quickstarts/plot_multi_label_classification.py
@@ -27,15 +27,15 @@
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp]' -U --quiet #--user
 
 Some properties calculated by ``deepchecks.nlp`` require additional packages to be installed. You can
 install them by running:
 
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp-properties] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp-properties]' -U --quiet #--user
 
 Setting Up
 ==========

diff --git a/docs/source/nlp/tutorials/quickstarts/plot_text_classification.py b/docs/source/nlp/tutorials/quickstarts/plot_text_classification.py
@@ -31,15 +31,15 @@
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp]' -U --quiet #--user
 
 Some properties calculated by ``deepchecks.nlp`` require additional packages to be installed. You can
 install them by running:
 
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp-properties] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp-properties]' -U --quiet #--user
 
 Setting Up
 ==========

diff --git a/docs/source/nlp/tutorials/quickstarts/plot_token_classification.py b/docs/source/nlp/tutorials/quickstarts/plot_token_classification.py
@@ -31,15 +31,15 @@
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp]' -U --quiet #--user
 
 Some properties calculated by ``deepchecks.nlp`` require additional packages to be installed. You can
 also install them by running:
 
 .. code:: python
 
     import sys
-    !{sys.executable} -m pip install deepchecks[nlp-properties] -U --quiet #--user
+    !{sys.executable} -m pip install 'deepchecks[nlp-properties]' -U --quiet #--user
 
 Setting Up
 ==========