8000 PR: Transform linear algebra functions extension md to rst by steff456 · Pull Request #384 · data-apis/array-api · GitHub
[go: up one dir, main page]

Skip to content

PR: Transform linear algebra functions extension md to rst #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 3, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Merge remote-tracking branch 'upstream/main' into ext-linalg-rst
  • Loading branch information
steff456 committed Jan 31, 2022
commit 587b4429cf005c9e48d85881aff3d3d6554e5d96
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ _defaults: &defaults
docker:
# CircleCI maintains a library of pre-built images
# documented at https://circleci.com/docs/2.0/circleci-images/
- image: circleci/python:3.8.0
- image: cimg/python:3.10.2
working_directory: ~/repo

jobs:
Expand All @@ -19,7 +19,7 @@ jobs:
name: build docs
no_output_timeout: 25m
command: |
sudo pip install -r requirements.txt
pip install -r requirements.txt
sphinx-build -b html -WT --keep-going spec build/latest -d doctrees
- store_artifacts:
path: build/latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions/checkout@master
- uses: actions/setup-python@v2
with:
python-version: '3.8' # Version range or exact version of a Python version to use, using semvers version range syntax.
python-version: '3.10.2' # Version range or exact version of a Python version to use, using semvers version range syntax.
architecture: 'x64' # (x64 or x86)
- run: |
# add dependencies based on the conf.py
Expand Down
1,556 changes: 0 additions & 1,556 deletions spec/API_specification/elementwise_functions.md

This file was deleted.

86 changes: 86 additions & 0 deletions spec/API_specification/elementwise_functions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
.. _element-wise-functions:

Element-wise Functions
======================

Array API specification for element-wise functions.

A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.

- Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
- Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
- Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
- Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
- Functions may only be required for a subset of input data type. Libraries may choose to implement functions for additional data types, but that behavior is not required by the specification. See :ref:`data-type-categories`.
- Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
- Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
- Unless stated otherwise, element-wise mathematical functions must satisfy the minimum accuracy requirements defined in :ref:`accuracy`.

Objects in API
--------------

.. currentmodule:: signatures.elementwise_functions

..
NOTE: please keep the functions in alphabetical order

.. autosummary::
:toctree: generated
:template: method.rst

abs
acos
acosh
add
asin
asinh
atan
atan2
atanh
bitwise_and
bitwise_left_shift
bitwise_invert
bitwise_or
bitwise_right_shift
bitwise_xor
ceil
cos
cosh
divide
equal
exp
expm1
floor
floor_divide
greater
greater_equal
isfinite
isinf
isnan
less
less_equal
log
log1p
log2
log10
logaddexp
logical_and
logical_not
logical_or
logical_xor
multiply
negative
not_equal
positive
pow
remainder
round
sign
sin
sinh
square
sqrt
subtract
tan
tanh
trunc
142 changes: 0 additions & 142 deletions spec/API_specification/linear_algebra_functions.md

This file was deleted.

29 changes: 29 additions & 0 deletions spec/API_specification/linear_algebra_functions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Linear Algebra Functions
========================

Array API specification for linear algebra functions.

A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.

* Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
* Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
* Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
* Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
* Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
* Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.

.. currentmodule:: signatures.linear_algebra_functions

Objects in API
--------------
..
NOTE: please keep the functions in alphabetical order

.. autosummary::
:toctree: generated
:template: method.rst

matmul
matrix_transpose
tensordot
vecdot
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.
0