Skip to content

Commit c8229f3

Browse files
edwinsolisfsyurkevi
authored andcommitted
Updated install docs
1 parent 6959b30 commit c8229f3

File tree

4 files changed

+22
-11
lines changed

4 files changed

+22
-11
lines changed

docs/functions.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Functions
2121
Documentation grouped by category:
2222

2323

24-
.. collapse:: Arrayfire Classes
24+
.. collapse:: ArrayFire Classes
2525

2626
.. list-table::
2727

@@ -33,7 +33,7 @@ Documentation grouped by category:
3333
- Represents an ArrayFire Feature Extraction class
3434

3535

36-
.. collapse:: Arrayfire Functions
36+
.. collapse:: ArrayFire Functions
3737

3838
.. list-table::
3939

@@ -529,7 +529,7 @@ Documentation grouped by category:
529529
- Creates an array filled with zeros.
530530

531531

532-
.. collapse:: Arrayfire Functions by Category
532+
.. collapse:: ArrayFire Functions by Category
533533

534534
.. list-table::
535535

@@ -552,7 +552,7 @@ Documentation grouped by category:
552552
* - :doc:`Special Functions <special_functions>`
553553
- Functions for convolutions, creating and applying specific types of filters, commonly used in signal processing and analysis.
554554

555-
.. collapse:: Arrayfire Constants
555+
.. collapse:: ArrayFire Constants
556556

557557
.. list-table::
558558

docs/indexing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ You can use Python's slicing notation to define a range when indexing in **array
109109
Indexing using af.Array
110110
***************************
111111

112-
In Python with arrayfire, you can also index arrays using other **af.Array** objects. Arrayfire flattens the input and treats the elements inside the array
112+
In Python with arrayfire, you can also index arrays using other **af.Array** objects. ArrayFire flattens the input and treats the elements inside the array
113113
as column major indices to index the original Array as 1D Array.
114114

115115
.. code-block:: python

docs/installation.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
ArrayFire Installer
22
===================
33

4-
Installing ArrayFire couldn't be easier. Navigate to https://arrayfire.com/download and download the appropriate installer for the target architecture and operating system. Although ArrayFire can be `built from source <https://github.com/arrayfire/arrayfire-python/tree/master?tab=readme-ov-file#arrayfire-python-bindings>`_, the installers conveniently package necessary dependencies.
4+
To use ArrayFire-Python you require three things:
55

6-
Install the latest device drivers before using ArrayFire. Drivers and runtimes should be downloaded and installed from each device vendor's website.
6+
.. list-table::
77

8-
Install Instructions
9-
####################
8+
* - :literal:`arrayfire-python` package
9+
- You may install it through pip :literal:`pip install arrayfire-python` or from `building arrayfire-python wheel <../README.md>`_
10+
11+
* - :literal:`arrayfire-binary-python-wrapper`
12+
- You may download and install through pip :literal:`pip install arrayfire_binary_python_wrapper-0.8.0+af3.10.0 -f https://arrayfire.com/python/binaries` which will come with ArrayFire C Libraries as well. You may also `build from source <https://github.com/arrayfire/arrayfire-binary-python-wrapper>`_ without the C Libraries.
13+
14+
* - :literal:`ArrayFire C/C++ Libraries`
15+
- If you build the binary wrapper from source or wish to program with ArrayFire in C/C++, navigate to https://arrayfire.com/download and download the appropriate installer for the target architecture and operating system. Although ArrayFire can be `built from source <https://github.com/arrayfire/arrayfire-python/tree/master?tab=readme-ov-file#arrayfire-python-bindings>`_, the installers conveniently package necessary dependencies.
16+
17+
Below we detail more on the ArrayFire C Libraries installation procedure. Install the latest device drivers before using ArrayFire. Drivers and runtimes should be downloaded and installed from each device vendor's website.
18+
19+
Install Instructions for ArrayFire C Libraries
20+
###############################################
1021

1122
* :ref:`Windows <Windows>`
1223
* :ref:`Linux <Linux>`

docs/overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Installing ArrayFire
1616

1717
Install ArrayFire using either a binary installer for Windows, OSX, or Linux or download it from source:
1818
* `Download and install Binaries <https://arrayfire.com/download/>`_
19-
* `Build from source <https://github.com/arrayfire/arrayfire-py>`_
19+
* `Build from source <https://github.com/arrayfire/arrayfire>`_
2020

2121
Using ArrayFire
2222
***************
@@ -112,4 +112,4 @@ Email
112112
Citations and Acknowledgements
113113
******************************
114114

115-
If you redistribute ArrayFire, please follow the terms established in `the license <https://github.com/arrayfire/arrayfire-python/blob/master/LICENSE>`_. If you wish to cite ArrayFire in an academic publication, please use the following reference:
115+
If you redistribute ArrayFire, please follow the terms established in `the license <https://github.com/arrayfire/thon/blob/master/LICENSE>`_. If you wish to cite ArrayFire in an academic publication, please use the following reference:

0 commit comments

Comments
 (0)