diff --git a/docs/source/index.rst b/docs/source/index.rst index 4ca641801..a9b7348d5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -46,12 +46,12 @@ this will leverage the Databricks H3 expressions when using H3 grid system. Mosaic provides: - * easy conversion between common spatial data encodings (WKT, WKB and GeoJSON); - * constructors to easily generate new geometries from Spark native data types; - * many of the OGC SQL standard :code:`ST_` functions implemented as Spark Expressions for transforming, aggregating and joining spatial datasets; - * high performance through implementation of Spark code generation within the core Mosaic functions; - * optimisations for performing point-in-polygon joins using an approach we co-developed with Ordnance Survey (`blog post `_); and - * the choice of a Scala, SQL and Python API. +* easy conversion between common spatial data encodings (WKT, WKB and GeoJSON); +* constructors to easily generate new geometries from Spark native data types; +* many of the OGC SQL standard :code:`ST_` functions implemented as Spark Expressions for transforming, aggregating and joining spatial datasets; +* high performance through implementation of Spark code generation within the core Mosaic functions; +* optimisations for performing point-in-polygon joins using an approach we co-developed with Ordnance Survey (`blog post `_); and +* the choice of a Scala, SQL and Python API. .. note:: For Mosaic versions < 0.4 please use the `0.3 docs `_. @@ -67,37 +67,36 @@ We recommend using Databricks Runtime versions 13.3 LTS with Photon enabled. Mosaic 0.4.x series only supports DBR 13.x DBRs. If running on a different DBR it will throw an exception: -**DEPRECATION ERROR: Mosaic v0.4.x series only supports Databricks Runtime 13. You can specify -`%pip install 'databricks-mosaic<0.4,>=0.3'` for DBR < 13.** + DEPRECATION ERROR: Mosaic v0.4.x series only supports Databricks Runtime 13. + You can specify `%pip install 'databricks-mosaic<0.4,>=0.3'` for DBR < 13. Mosaic 0.4.x series issues an ERROR on standard, non-Photon clusters `ADB `_ | `AWS `_ | -`GCP `_ : +`GCP `_: -**DEPRECATION ERROR: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for spatial -AI benefits; Mosaic 0.4.x series restricts executing this cluster.** + DEPRECATION ERROR: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for + spatial AI benefits; Mosaic 0.4.x series restricts executing this cluster. As of Mosaic 0.4.0 (subject to change in follow-on releases) - * `Assigned Clusters `_ : Mosaic Python, SQL, R, and Scala APIs. - * `Shared Access Clusters `_ : Mosaic Scala API (JVM) with - Admin `allowlisting `_ ; - Python bindings to Mosaic Scala APIs are blocked by Py4J Security on Shared Access Clusters. +* `Assigned Clusters `_: Mosaic Python, SQL, R, and Scala APIs. +* `Shared Access Clusters `_: Mosaic Scala API (JVM) with + Admin `allowlisting `_; + Python bindings to Mosaic Scala APIs are blocked by Py4J Security on Shared Access Clusters. .. warning:: - Mosaic 0.4.x SQL bindings for DBR 13 can register with Assigned clusters (as Hive UDFs), but not Shared Access due - to `Unity Catalog `_ API changes, more `here `_. + Mosaic 0.4.x SQL bindings for DBR 13 can register with Assigned clusters (as Hive UDFs), but not Shared Access due + to `Unity Catalog `_ API changes, more `here `_. .. note:: As of Mosaic 0.4.0 (subject to change in follow-on releases) - * `Unity Catalog `_ : Enforces process isolation which is difficult to - accomplish with custom JVM libraries; as such only built-in (aka platform provided) JVM APIs can be invoked from other - supported languages in Shared Access Clusters. - * `Volumes `_ : Along the same principle of isolation, - clusters (both assigned and shared access) can read Volumes via relevant built-in readers and writers or via custom - python calls which do not involve any custom JVM code. - + * `Unity Catalog `_ enforces process isolation which is difficult + to accomplish with custom JVM libraries; as such only built-in (aka platform provided) JVM APIs can be invoked from + other supported languages in Shared Access Clusters. + * Along the same principle of isolation, clusters (both Assigned and Shared Access) can read + `Volumes `_ via relevant built-in readers and + writers or via custom python calls which do not involve any custom JVM code. Version 0.3.x Series ==================== @@ -111,10 +110,10 @@ For Mosaic versions < 0.4.0 please use the `0.3.x docs `_ | `AWS `_ | -`GCP `_ : +`GCP `_: -**DEPRECATION WARNING: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for spatial -AI benefits; Mosaic will stop working on this cluster after v0.3.x.** + DEPRECATION WARNING: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for spatial + AI benefits; Mosaic will stop working on this cluster after v0.3.x. If you are receiving this warning in v0.3.11+, you will want to begin to plan for a supported runtime. The reason we are making this change is that we are streamlining Mosaic internals to be more aligned with future product APIs which are diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst index ed96c3198..d1cf54d1e 100644 --- a/docs/source/usage/installation.rst +++ b/docs/source/usage/installation.rst @@ -10,32 +10,32 @@ Supported platforms Mosaic 0.4.x series only supports DBR 13.x DBRs. If running on a different DBR it will throw an exception: -**DEPRECATION ERROR: Mosaic v0.4.x series only supports Databricks Runtime 13. You can specify -`%pip install 'databricks-mosaic<0.4,>=0.3'` for DBR < 13.** + DEPRECATION ERROR: Mosaic v0.4.x series only supports Databricks Runtime 13. + You can specify `%pip install 'databricks-mosaic<0.4,>=0.3'` for DBR < 13. Mosaic 0.4.x series issues an ERROR on standard, non-Photon clusters `ADB `_ | `AWS `_ | -`GCP `_ : +`GCP `_: -**DEPRECATION ERROR: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for spatial -AI benefits; Mosaic 0.4.x series restricts executing this cluster.** + DEPRECATION ERROR: Please use a Databricks Photon-enabled Runtime for performance benefits or Runtime ML for + spatial AI benefits; Mosaic 0.4.x series restricts executing this cluster. As of Mosaic 0.4.0 (subject to change in follow-on releases) - * `Assigned Clusters `_ : Mosaic Python, SQL, R, and Scala APIs. - * `Shared Access Clusters `_ : Mosaic Scala API (JVM) with - Admin `allowlisting `_ ; - Python bindings to Mosaic Scala APIs are blocked by Py4J Security on Shared Access Clusters. +* `Assigned Clusters `_: Mosaic Python, SQL, R, and Scala APIs. +* `Shared Access Clusters `_: Mosaic Scala API (JVM) with + Admin `allowlisting `_; + Python bindings to Mosaic Scala APIs are blocked by Py4J Security on Shared Access Clusters. .. note:: As of Mosaic 0.4.0 (subject to change in follow-on releases) - * `Unity Catalog `_ : Enforces process isolation which is difficult to - accomplish with custom JVM libraries; as such only built-in (aka platform provided) JVM APIs can be invoked from other - supported languages in Shared Access Clusters. - * `Volumes `_ : Along the same principle of isolation, - clusters (both assigned and shared access) can read Volumes via relevant built-in readers and writers or via custom - python calls which do not involve any custom JVM code. + * `Unity Catalog `_ enforces process isolation which is difficult + to accomplish with custom JVM libraries; as such only built-in (aka platform provided) JVM APIs can be invoked from + other supported languages in Shared Access Clusters. + * Along the same principle of isolation, clusters (both assigned and shared access) can read + `Volumes `_ via relevant built-in readers and + writers or via custom python calls which do not involve any custom JVM code. If you have cluster creation permissions in your Databricks workspace, you can create a cluster using the instructions