Open
Conversation
lucascolley
approved these changes
Mar 23, 2026
spec/draft/migration_guide.md
Outdated
Comment on lines
+5
to
+6
| This page is meant to help migrate your codebase to an array API standard | ||
| compliant implementation. The guide is divided into three parts. |
Member
There was a problem hiding this comment.
'Compliance' seems more relevant for producers. I guess for consumers it is rather about becoming interoperable with compliant implementations?
Contributor
Author
There was a problem hiding this comment.
added the consumers' perspective as well in the intro sentence.
spec/draft/migration_guide.md
Outdated
| The first part gives an overview of the {ref}`ecosystem` libraries, that | ||
| are helpful in different contexts when working with the array API standard. | ||
|
|
||
| The first part is dedicated for {ref}`array-producers`. If your library |
spec/draft/migration_guide.md
Outdated
| their system/algorithm. | ||
|
|
||
| The second part delves into details for Array API compatibility for | ||
| The second part delves into details for array API standard compatibility for |
spec/draft/migration_guide.md
Outdated
| The first part gives an overview of the {ref}`ecosystem` libraries, that | ||
| are helpful in different contexts when working with the array API standard. | ||
|
|
||
| The first part is dedicated for {ref}`array-producers`. If your library |
Member
There was a problem hiding this comment.
Suggested change
| The first part is dedicated for {ref}`array-producers`. If your library | |
| The first part is dedicated to {ref}`array-producers`. If your library |
spec/draft/migration_guide.md
Outdated
Comment on lines
12
to
13
| mimics, for example, NumPy's or PyTorch's functionality, then you can find in | ||
| the first part additional instructions and guidance on how to ensure |
Member
There was a problem hiding this comment.
Suggested change
| mimics, for example, NumPy's or PyTorch's functionality, then you can find in | |
| the first part additional instructions and guidance on how to ensure | |
| mimics, for example, NumPy's or PyTorch's functionality, then you can find in | |
| here additional instructions and guidance on how to ensure |
spec/draft/migration_guide.md
Outdated
Comment on lines
42
to
43
| Although NumPy, Dask, CuPy, and PyTorch support the array API standard, there | ||
| are still some corner cases where their behavior diverges from the standard. |
Member
There was a problem hiding this comment.
still not sure if we should claim support in this first phrase, particularly for Dask and PyTorch
Contributor
Author
There was a problem hiding this comment.
right, I removed Dask and PyTorch from here.
spec/draft/migration_guide.md
Outdated
| into array objects. As an array consumer, you can still rely on the original | ||
| API while having access to the standard compatible one. | ||
| `array-api-compat` provides a compatibility layer to cover an additional subset | ||
| of these corner cases. This is also accompanied by a few utility functions fo |
Member
There was a problem hiding this comment.
Suggested change
| of these corner cases. This is also accompanied by a few utility functions fo | |
| of these corner cases. This is also accompanied by a few utility functions for |
spec/draft/migration_guide.md
Outdated
Comment on lines
+46
to
+47
| easier introspection into array objects. As an array consumer, you can still | ||
| rely on the original API while having access to the standard compatible one. |
Member
There was a problem hiding this comment.
Suggested change
| easier introspection into array objects. As an array consumer, you can still | |
| rely on the original API while having access to the standard compatible one. | |
| easier introspection into array objects. As an array consumer, you can consume | |
| standard-compliant namespaces as well as the wrapped namespaces in | |
| `array-api-compat` at the same time. |
spec/draft/migration_guide.md
Outdated
Comment on lines
+59
to
+61
| implementation of the array API standard. As a consumer, you can use | ||
| `array-api-strict` for parametrising tests with it as an array namespace | ||
| to ensure your code uses APIs compliant with the standard. |
Member
There was a problem hiding this comment.
Suggested change
| implementation of the array API standard. As a consumer, you can use | |
| `array-api-strict` for parametrising tests with it as an array namespace | |
| to ensure your code uses APIs compliant with the standard. | |
| implementation of the array API standard. As a consumer, you can use | |
| `array-api-strict` in parametrising tests over the array namespace | |
| to ensure your code uses only APIs which are in the standard. |
spec/draft/migration_guide.md
Outdated
| standard define it: | ||
| namespace variable. The convention used in the ecosystem is to name it `xp`. | ||
| Then, it is vital to ensure that each method and function call is something that | ||
| the array API standard supports. For example, `dot` is present in the NumPy's |
Member
There was a problem hiding this comment.
Suggested change
| the array API standard supports. For example, `dot` is present in the NumPy's | |
| the array API standard supports. For example, `dot` is present in the NumPy |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@lucascolley review of migration guide.