Skip to content

Commit 603613b

Browse files
committed
Reference doc clean up + links
1 parent 763fe78 commit 603613b

12 files changed

Lines changed: 197 additions & 162 deletions

docs/advanced-analytics/concepts/extension-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Installation of the Python 3.5 runtime and interpreter ensures near-complete com
2323

2424
SQL Server includes both open-source and proprietary packages. The Python runtime installed by Setup is Anaconda 4.2 with Python 3.5. The Python runtime is installed independently of SQL tools, and is executed outside of core engine processes, in the extensibility framework. As part of the installation of Machine Learning Services with Python, you must consent to the terms of the GNU Public License.
2525

26-
SQL Server does not modify the Python executables, but you must use the version of Python installed by Setup because that version is the one that the proprietary packages are built and tested on. For a list of packages supported by the Anaconda distribution, see the Continuum analytics site: [Anaconda package list](https://docs.continuum.io/anaconda/pkg-docs).
26+
SQL Server does not modify the Python executables, but you must use the version of Python installed by Setup because that version is the one that the proprietary packages are built and tested on. For a list of packages supported by the Anaconda distribution, see the Continuum analytics site: [Anaconda package list](https://docs.continuum.io/anaconda/packages/pkg-docs).
2727

2828
The Anaconda distribution associated with a specific database engine instance can be found in the folder associated with the instance. For example, if you installed SQL Server 2017 database engine with Machine Learning Services and Python on the default instance, look under `C:\Program Files\Microsoft SQL Server\MSSQL14.MSSQLSERVER\PYTHON_SERVICES`.
2929

docs/advanced-analytics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,6 @@ Learn how to use R and Python external libraries and languages on resident, rela
6464
| [RevoScaleR](https://docs.microsoft.com/machine-learning-server/r-reference/revoscaler/revoscaler) | R | Distributed and parallel processing for R tasks: data transformation, exploration, visualization, statistical and predictive analytics. |
6565
| [MicrosoftML](https://docs.microsoft.com/machine-learning-server/r-reference/microsoftml/microsoftml-package) | R | Functions based on Microsoft's AI algorithms, adapted for R. |
6666
| [olapR](https://docs.microsoft.com/machine-learning-server/r-reference/olapr/olapr) | R | Imports data from OLAP cube.s |
67-
| [sqlRUtils]() | R | Helper functions for encapsulating R and T-SQL. |
67+
| [sqlRUtils](https://docs.microsoft.com/machine-learning-server/r-reference/sqlrutils/sqlrutils) | R | Helper functions for encapsulating R and T-SQL. |
6868
[revoscalepy](https://docs.microsoft.com/machine-learning-server/python-reference/revoscalepy/revoscalepy-package) | Python | Distributed and parallel processing for Python tasks: data transformation, exploration, visualization, statistical and predictive analytics. |
6969
| [microsoftml](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/microsoftml-package) | Python | Functions based on Microsoft's AI algorithms, adapted for Python. |

docs/advanced-analytics/java/extension-java.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Java language extension in SQL Server 2019 | Microsoft Docs
3-
description: Run Java code on SQL Server 2019 using the Java language extension.
3+
description: Install, configure, and validate the Java language extension on SQL Server 2019 for both Linux and Windows systems.
44
ms.prod: sql
55
ms.technology: machine-learning
66

docs/advanced-analytics/java/java-first-sample.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Java language extension in SQL Server 2019 | Microsoft Docs
3-
description: Run Java code on SQL Server 2019 using the Java language extension.
3+
description: Run Java sample code on SQL Server 2019 to learn steps for using the Java language extension with SQL Server data.
44
ms.prod: sql
55
ms.technology: machine-learning
66

docs/advanced-analytics/python/install-additional-python-packages-on-sql-server.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more information about package location and installation paths, see [Get R o
2121

2222
+ [SQL Server 2017 Machine Learning Services (In-Database)](../install/sql-machine-learning-services-windows-install.md) with the Python language option.
2323

24-
+ Packages must be Python 3.5 compliant and run on Windows.
24+
+ Packages must be Python 3.5-compliant and run on Windows.
2525

2626
+ Administrative access to the server is required to install packages.
2727

@@ -41,13 +41,6 @@ Package installation is per instance. If you have multiple instances of Machine
4141

4242
The package installed in this example is [CNTK](https://docs.microsoft.com/cognitive-toolkit/), a framework for deep learning from Microsoft that supports customization, training, and sharing of different types of neural networks.
4343

44-
> [!TIP]
45-
> Need help configuring your Python tools? See these blogs:
46-
>
47-
> [Getting Started with Python Web Services using Machine Learning Server](https://blogs.msdn.microsoft.com/mlserver/2017/12/13/getting-started-with-python-web-services-using-machine-learning-server/)
48-
>
49-
> [David Crook: Microsoft Cognitive Toolkit + VS Code](https://dacrook.com/cntk-vs-code-awesome/)
50-
5144
### Step 1. Download the Windows version of the Python package
5245

5346
+ If you are installing Python packages on a server with no internet access, you must download the WHL file to a different computer and then copy it to the server.

docs/advanced-analytics/python/ref-py-microsoftml.md

Lines changed: 103 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,112 @@ manager: cgronlun
1313
# microsoftml (Python module in SQL Server)
1414
[!INCLUDE[appliesto-ss-xxxx-xxxx-xxx-md-winonly](../../includes/appliesto-ss-xxxx-xxxx-xxx-md-winonly.md)]
1515

16-
**microsoftml** is a Python35-compatible module from Microsoft that provides machine learning algorithms. It is included in several products, including SQL Server 2017 Machine Learning Services (with Python), Microsoft Machine Learning Server, the Python client libraries, and several virtual machine images on Azure.
16+
**microsoftml** is a Python35-compatible module from Microsoft providing high-performance machine learning algorithms. It includes functions for training and transformations, scoring, text and image analysis, and feature extraction for deriving values from existing data.
1717

18-
The machine learning APIs were developed by Microsoft for internal machine learning applications, and have been refined over the years to support high performance on big data, using multicore processing and fast data streaming. MicrosoftML also includes numerous transformations for text and image processing.
18+
Functions in **microsoftml** are callable in Python code encapsulated in stored procedures. Most developers build **microsoftml** solutions locally, and then migrate finished Python code to stored procedures as a deployment exercise.
1919

20-
There is an R-equivalent version of this package, [MicrosoftML](../r/ref-r-microsoftml.md), containing equivalent functions.
20+
The machine learning APIs were developed by Microsoft for internal machine learning applications and have been refined over the years to support high performance on big data, using multicore processing and fast data streaming. This package originated as a Python equivalent of an R version, [MicrosoftML](../r/ref-r-microsoftml.md), that has similar functions.
21+
22+
## Documentation
23+
24+
The **microsoftml** library is distributed in multiple Microsoft products, but usage is the same whether you get the library in SQL Server or another product. Because the functions are the same, [documentation for indvidual microsoftml functions](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/microsoftml-package) is published to just one location under the [Python reference](https://docs.microsoft.com/machine-learning-server/python-reference/introducing-python-package-reference) for Microsoft Machine Learning Server. Should any product-specific behaviors exist, discrepancies will be noted in the function help page.
25+
26+
## Versions and platforms
27+
28+
The **microsoftml** module is based on Python 3.5 and available only when you install one of the following Microsoft products or downloads:
29+
30+
+ [SQL Server 2017 Machine Learning Services](../install/sql-machine-learning-services-windows-install.md)
31+
+ [Microsoft Machine Learning Server 9.2.0 or later](https://docs.microsoft.com/machine-learning-server/)
32+
+ [Python client libraries for a data science client](setup-python-client-tools-sql.md)
33+
34+
> [!NOTE]
35+
> Full product release versions are Windows-only, starting with SQL Server 2017. Linux support for **microsoftml** is new in [SQL Server 2019 Preview](../../linux/sql-server-linux-setup-machine-learning.md).
2136
2237
## Package dependencies
2338

24-
Algorithms in **microsoftml** are used with data source objects based on **revoscalepy** functions. Whenever you use **microsoftml**, you almost always have to make **revoscalepy** in the same script to load the data.
39+
Algorithms in **microsoftml** depend on [revoscalepy](ref-py-revoscalepy.md) for:
40+
41+
+ Data source objects. Data consumed by **microsoftml** functions are created using **revoscalepy** functions.
42+
+ Remote computing (shifting function execution to a remote SQL Server instance). The **revoscalepy** library provides functions for creating and activating a remote compute context for SQL server.
43+
44+
In most cases, you will load the packages together whenever you are using **microsoftml**.
45+
46+
## Functions by category
47+
48+
This section lists the functions by category to give you an idea of how each one is used. You can also use the [table of contents](https://docs.microsoft.com/machine-learning-server/python-reference/introducing-python-package-reference) to find functions in alphabetical order.
49+
50+
## 1-Training functions
51+
52+
| Function | Description |
53+
|----------|-------------|
54+
|[microsoftml.rx_ensemble](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-ensemble.md) | Train an ensemble of models |
55+
|[microsoftml.rx_fast_forest](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-fast-forest.md) | Random Forest |
56+
|[microsoftml.rx_fast_linear](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-fast-linear.md) | Linear Model with Stochastic Dual Coordinate Ascent |
57+
|[microsoftml.rx_fast_trees](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-fast-trees.md) | Boosted Trees |
58+
|[microsoftml.rx_logistic_regression](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-logistic-regression.md) | Logistic Regression |
59+
|[microsoftml.rx_neural_network](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-neural-network.md) | Neural Network |
60+
|[microsoftml.rx_oneclass_svm](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-oneclass-svm.md) | Anomaly Detection |
61+
62+
<a name="ml-transforms"></a>
63+
64+
## 2-Transform functions
65+
66+
### Categorical variable handling
67+
68+
| Function | Description |
69+
|----------|-------------|
70+
|[microsoftml.categorical](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/categorical.md) | Converts a text column into categories |
71+
|[microsoftml.categorical_hash](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/categorical-hash.md) | Hashes and converts a text column into categories |
2572

26-
+ [revoscalepy module in SQL Server](ref-py-revoscalepy.md)
27-
+ [revoscalepy function reference](https://docs.microsoft.com/r-server/python-reference/revoscalepy/revoscalepy-package)
73+
### Schema manipulation
2874

29-
## How to call microsoftml in SQL Server
75+
| Function | Description |
76+
|----------|-------------|
77+
|[microsoftml.concat](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/concat.md) | Concatenates multiple columns into a single vector |
78+
|[microsoftml.drop_columns](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/drop-columns.md) | Drops columns from a dataset |
79+
|[microsoftml.select_columns](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/select-columns.md) | Retains columns of a dataset |
80+
81+
82+
### Variable selection
83+
84+
| Function | Description |
85+
|----------|-------------|
86+
|[microsoftml.count_select](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/count-select.md) |Feature selection based on counts |
87+
|[microsoftml.mutualinformation_select](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/mutualinformation-select.md) | Feature selection based on mutual information |
88+
89+
90+
### Text analytics
91+
92+
| Function | Description |
93+
|----------|-------------|
94+
|[microsoftml.featurize_text](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/featurize-text.md) | Converts text columns into numerical features |
95+
|[microsoftml.get_sentiment](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/get-sentiment.md) | Sentiment analysis |
96+
97+
98+
### Image analytics
99+
100+
| Function | Description |
101+
|----------|-------------|
102+
|[microsoftml.load_image](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/load-image.md) | Loads an image |
103+
|[microsoftml.resize_image](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/resize-image.md) | Resizes an Image |
104+
|[microsoftml.extract_pixels](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/extract-pixels.md) | Extracts pixels form an image |
105+
|[microsoftml.featurize_image](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/featurize-image.md) | Converts an image into features |
106+
107+
### Featurization functions
108+
109+
| Function | Description |
110+
|----------|-------------|
111+
|[microsoftml.rx_featurize](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-featurize.md) | Data transformation for data sources |
112+
113+
<a name="ml-scoring"></a>
114+
115+
## 3-Scoring functions
116+
117+
| Function | Description |
118+
|----------|-------------|
119+
|[microsoftml.rx_predict](https://docs.microsoft.com/machine-learning-server/python-reference/microsoftml/rx-predict.md) | Scores using a Microsoft machine learning model |
120+
121+
## How to call microsoftml
30122

31123
The **microsoftml** package for Python is installed by default, but not loaded by default when you start a Python session using the Python executables installed with SQL Server.
32124

@@ -40,4 +132,7 @@ from revoscalepy.etl.RxImport import rx_import_datasource
40132

41133
## See Also
42134

43-
[Python tutorials](../tutorials/sql-server-python-tutorials.md)
135+
+ [Python tutorials](../tutorials/sql-server-python-tutorials.md)
136+
+ [Tutorial: Embed Python code in T-SQL](../tutorials/run-python-using-t-sql.md)
137+
+ [Python Reference (Microsoft Machine Learning Server)](https://docs.microsoft.com/machine-learning-server/python-reference/introducing-python-package-reference)
138+

0 commit comments

Comments
 (0)