Skip to content
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.

Sign up for GitHub

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

docs: add migration guide page #668

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add migration guide page #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d16816
Add migration guide
steff456 Jul 30, 2023
e1330e5
add review changes
steff456 Aug 4, 2023
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
1 change: 1 addition & 0 deletions spec/draft/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@ Contents
:caption: Other
:maxdepth: 1

migration_guide
changelog
license
16 changes: 16 additions & 0 deletions spec/draft/migration_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Migration Guide

## Introduction

The Array API Standard was based in the common APIs across multiple Python array libraries as a response to the fragmentation of the ecosystem. It was decided for the Array API Standard to be as compact as possible, meaning that it doesn't include all the creation and manipulation functions available in other libraries resulting that in some cases library-specific code paths may need to be used. If you encounter a function that is not easy to translate, please check if it has an open discussion in the [issue tracker](https://github.com/data-apis/array-api/issues), if not please request it via a new issue.

The aim of this guide is to help users get started with the use of the Array API by providing common equivalents with the NumPy API. Your input can be very valuable for us, so please feel free to contribute to this page by adding more equivalents.

Depending on the version of the Array API Standard that you are intended to use, the number of total APIs may vary and this migration guide is using the latest version `v2022.12`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is important to mention what version this page is using, but I also fear this can starts to be a maintenance burden. So please let me know if it is just better to refer to the "latest version" or if it is ok to flag the actual version.


## Equivalents

| NumPy | Array API |
| ----- | --------- |
| `ravel(x)` | `reshape(x, (-1,))` |
| `flatten(x)` | `reshape(x, (-1,))` |