-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation for setting up an api key
- Loading branch information
1 parent
c61c213
commit ca4dff5
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,6 +17,7 @@ | |
:caption: The Basics | ||
|
||
overview/get_started.rst | ||
overview/api_key.rst | ||
demos/quickstart.ipynb | ||
|
||
|
||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Setting up your API key | ||
======================= | ||
|
||
You can generate a personal api key for Ivy by signing up for free at https://ivy.dev/signin. | ||
This will grant you additional transpilations that can be used for completely free on any code! Find out more at https://ivy.dev/. | ||
|
||
Using your API key | ||
------------------ | ||
|
||
There are two ways to use your api key in your local environment. The easiest is to export it as the IVY_KEY environment variable, like so: | ||
|
||
.. code-block:: bash | ||
export IVY_KEY=<my_key> | ||
The other way is to create a 'ivy-key.pem' file in your local directory, containing just your api key. Ivy should automatically detect this file and use your key. | ||
|
||
If you run into any problems with your api key, feel free to raise an issue at https://github.com/ivy-llc/ivy/issues, or get in touch at [email protected]. |