amd/blis
1
0
Fork 0
mirror of https://github.com/amd/blis.git synced 2026-04-20 15:48:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small updates to KernelsHowTo.md, BLISTypedAPI.md.

Browse Source 
Details:
- Minor updates to BLISTypedAPI.md, mostly to bring terminology
  up-to-date with the new "typed API" classification.
- Added contents section to KernelsHowTo.md.
This commit is contained in:
Field G. Van Zee
2018-07-09 18:40:13 -05:00
parent 1fd3bce59e
commit bf10d8624e
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/BLISTypedAPI.md
View File

@@ -27,14 +27,15 @@
# Introduction
This document summarizes the user-level BLIS APIs, including BLIS-specific type definitions, header files, and function prototypes. This document also includes APIs to key [micro-]kernels which are used to accelerate and optimize various level-2 and level-3 operations.
This document summarizes one of the primary native APIs in BLIS--the "typed" API. Here, we also discuss BLIS-specific type definitions, header files, and prototypes to auxiliary functions. This document also includes APIs to key kernels which are used to accelerate and optimize various level-2 and level-3 operations, though the [Kernels Guide](KernelsHowTo.md) goes into more detail, especially for level-3 micro-kernels.
There are many functions that BLIS implements that are not listed here, either because they are lower-level functions, or they are considered for use primarily by developers and experts.
For curious readers, the typed API was given its name (a) because it exposes the floating-point types in the names of its functions, and (b) to contrast it with the other native API in BLIS, the object API, which is [documented here](BLISObjectAPI.md). (The third API supported by BLIS is the BLAS compatibility layer, which mimics conventional Fortran-77 BLAS.)
## BLIS types
The following tables list various types used throughout the BLIS API.
The following tables list various types used throughout the BLIS typed API.
### Integer-based types

16
docs/KernelsHowTo.md
View File

@@ -1,3 +1,19 @@
## Contents
* **[Contents](KernelsHowTo.md#contents)**
* **[Introduction](KernelsHowTo.md#introduction)**
* **[BLIS kernels summary](KernelsHowTo.md#blis-kernels-summary)**
* **[Level-3](KernelsHowTo.md#level-3)**
* **[Level-1f](KernelsHowTo.md#level-1f)**
* **[Level-1v](KernelsHowTo.md#level-1v)**
* **[Level-1v/-1f Dependencies for Level-2 operations](KernelsHowTo.md#level-1v-1f-dependencies-for-level-2-operations)**
* **[Calling kernels](KernelsHowTo.md#calling-kernels)**
* **[BLIS kernels reference](KernelsHowTo.md#blis-kernels-reference)**
* **[Level-3 micro-kernels](KernelsHowTo.md#level-3-micro-kernels)**
* **[Level-1f kernels](KernelsHowTo.md#level-1f-kernels)**
* **[Level-1v kernels](KernelsHowTo.md#level-1v-kernels)**
## Introduction
This wiki describes the computational kernels used by the BLIS framework.