Skip to content

Commit

Permalink
Github pages update for 2024.1 (#2710)
Browse files Browse the repository at this point in the history
* Github pages update

Github pages update

* Github pages update

Github pages update
  • Loading branch information
bdmoore1 authored Apr 11, 2024
1 parent 8ae3bbc commit 0f35480
Show file tree
Hide file tree
Showing 497 changed files with 96,031 additions and 32,083 deletions.
4 changes: 2 additions & 2 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9e0576089f1959485e798cc457d38354
tags: ecdfad4873649a72b4bd359271733676
config: c0c897ee976368f1711d3a2e5209655a
tags: 645f666f9bcd5a90fca523b33c5a78b7
181 changes: 109 additions & 72 deletions 404.html

Large diffs are not rendered by default.

34 changes: 30 additions & 4 deletions _sources/api/algorithms/covariance/covariance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,10 @@ Input
~~~~~
.. onedal_class:: oneapi::dal::covariance::compute_input


.. _covariance_c_api_result:

Result
~~~~~~
Result and Finalize Result
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::covariance::compute_result

Operation
Expand All @@ -76,4 +75,31 @@ Operation
:param input: Input data for the computing operation

Preconditions
| :expr:`input.data.is_empty == false`
| :expr:`input.data.is_empty == false`
.. _covariance_p_api:

Partial Training
----------------
.. _covariance_p_api_input:

Partial Input
~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::covariance::partial_compute_input

.. _covariance_p_api_result:

Partial Result and Finalize Input
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::covariance::partial_compute_result

.. _covariance_f_api:

Finalize Training
-----------------

-------------
Usage Example
-------------

.. include:: ../../../includes/covariance/covariance-usage-examples.rst
32 changes: 27 additions & 5 deletions _sources/api/algorithms/decomposition/pca.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ All types and functions in this section are declared in the
``oneapi::dal::pca`` namespace and be available via inclusion of the
``oneapi/dal/algo/pca.hpp`` header file.

Enum classes
------------
.. onedal_enumclass:: oneapi::dal::pca::normalization

Descriptor
----------
.. onedal_class:: oneapi::dal::pca::descriptor
Expand All @@ -54,7 +58,6 @@ Model
-----
.. onedal_class:: oneapi::dal::pca::model


.. _pca_t_api:

Training :cpp:expr:`train(...)`
Expand All @@ -65,11 +68,10 @@ Input
~~~~~
.. onedal_class:: oneapi::dal::pca::train_input


.. _pca_t_api_result:

Result
~~~~~~
Result and Finalize Result
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::pca::train_result

Operation
Expand All @@ -96,6 +98,27 @@ Operation
| :expr:`result.model.eigenvectors.row_count == 1`
| :expr:`result.model.eigenvectors.column_count == desc.component_count`
.. _pca_p_api:

Partial Training
----------------
.. _pca_p_api_input:

Partial Input
~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::pca::partial_train_input

.. _pca_p_api_result:

Partial Result and Finalize Input
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::pca::partial_train_result

.. _pca_f_api:

Finalize Training
-----------------

.. _pca_i_api:

Inference :cpp:expr:`infer(...)`
Expand All @@ -106,7 +129,6 @@ Input
~~~~~
.. onedal_class:: oneapi::dal::pca::infer_input


.. _pca_i_api_result:

Result
Expand Down
3 changes: 3 additions & 0 deletions _sources/api/algorithms/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ Refer to :ref:`Developer Guide <dg_algorithms>` for mathematical descriptions of
ensembles/index.rst
graph/index.rst
kernel-functions/index.rst
logistic-regression/index.rst
linear-regression/index.rst
nearest-neighbors/index.rst
optimizers/index.rst
objective-function/index.rst
pairwise-distances/index.rst
statistics/index.rst
Expand Down
26 changes: 26 additions & 0 deletions _sources/api/algorithms/linear-regression/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/
=================
Linear Regression
=================

This chapter describes programming interfaces of the Linear Regression algorithm implemented in |short_name|:

.. toctree::
:titlesonly:

linear-regression.rst
105 changes: 105 additions & 0 deletions _sources/api/algorithms/linear-regression/linear-regression.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/
.. highlight:: cpp
.. default-domain:: cpp

.. _api_linear-regression:

=================
Linear Regression
=================

.. include:: ../../../includes/linear-regression/linear-regression-introduction.rst

------------------------
Mathematical Formulation
------------------------

Refer to :ref:`Developer Guide: Linear Regression <alg_linear-regression>`.

---------------------
Programming Interface
---------------------

All types and functions from this section are declared in the
``oneapi::dal::linear_regression`` namespace and available by including the
``oneapi/dal/algo/linear_regression.hpp`` header file.

Descriptor
----------
.. onedal_class:: oneapi::dal::linear_regression::descriptor

Method Tags
~~~~~~~~~~~
.. onedal_tags_namespace:: oneapi::dal::linear_regression::method

Task Tags
~~~~~~~~~
.. onedal_tags_namespace:: oneapi::dal::linear_regression::task

.. _linreg_t_api:

Training
--------
.. _linreg_t_api_input:

Input
~~~~~
.. onedal_class:: oneapi::dal::linear_regression::train_input

.. _linreg_t_api_result:

Result and Finalize Result
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::linear_regression::train_result

.. _linreg_p_api:

Partial Training
----------------
.. _linreg_p_api_input:

Partial Input
~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::linear_regression::partial_train_input

.. _linreg_p_api_result:

Partial Result and Finalize Input
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. onedal_class:: oneapi::dal::linear_regression::partial_train_result

.. _linreg_f_api:

Finalize Training
-----------------

.. _linreg_i_api:

Inference
---------
.. _linreg_i_api_input:

Input
~~~~~
.. onedal_class:: oneapi::dal::linear_regression::infer_input

.. _linreg_i_api_result:

Result
~~~~~~
.. onedal_class:: oneapi::dal::linear_regression::infer_result
26 changes: 26 additions & 0 deletions _sources/api/algorithms/logistic-regression/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. ******************************************************************************
.. * Copyright 2023 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/
===================
Logistic Regression
===================

This chapter describes programming interfaces of the Logistic Regression algorithm implemented in |short_name|.

.. toctree::
:titlesonly:

logistic-regression.rst
Loading

0 comments on commit 0f35480

Please sign in to comment.