Skip to content

Commit 4dd2458

Browse files
authored
Update "How to use" in README.md
1 parent 259c1ef commit 4dd2458

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,10 @@ Done! You can now use Joey in your environment. If you want to make changes to t
4444
Joey is not available on PyPI yet.
4545

4646
## How to use
47-
The documentation is currently under construction. In the meantime, you can have a look at examples in `examples`.
47+
To start working with Joey, import the following packages:
48+
```
49+
import joey
50+
import joey.activation # If you want to use activation in neural network layers
51+
```
52+
53+
Afterwards, you are free to use all functions Joey offers. The recommended way of getting started is going through examples inside the `examples` directory in this repository and looking at `__doc__` that is provided in every Joey class and public/abstract class method.

0 commit comments

Comments
 (0)