Skip to content

Commit a055180

Browse files
Revise README with installation and usage details
Updated README to include installation instructions and clarify usage.
1 parent 71fbf74 commit a055180

1 file changed

Lines changed: 25 additions & 21 deletions

File tree

README.rst

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,11 @@
22
keras2c
33
#######
44

5-
|Python-Publish| |Python-Versions| |Codecov|
5+
|Python-Publish| |Python-Versions| |Codecov|
66

77
|License| |DOI|
88

9-
IMPORTANT: Keras2C has started updating to be compatible with newer versions of Python on July 9th, 2025. Changes may be breaking. To use the original/stable version, use the Release v1.0.2. https://github.com/PlasmaControl/keras2c/releases/tag/v1.0.2 with the command
10-
11-
.. code-block:: bash
12-
13-
git clone git@github.com:PlasmaControl/keras2c.git --branch v1.0.2
14-
15-
keras2c is a library for deploying keras neural networks in C99, using only standard libraries.
16-
It is designed to be as simple as possible for real time applications.
9+
keras2c is a library for deploying keras neural networks in C99, using only standard libraries. It is designed to be as simple as possible for real-time applications.
1710

1811
Please cite `this paper <https://doi.org/10.1016/j.engappai.2021.104182>`_ if you use this work in your research:
1912

@@ -22,13 +15,27 @@ Please cite `this paper <https://doi.org/10.1016/j.engappai.2021.104182>`_ if yo
2215
R. Conlin, K. Erickson, J. Abbate, and E. Kolemen, “Keras2c: A library for converting Keras neural networks to real-time compatible C,”
2316
Engineering Applications of Artificial Intelligence, vol. 100, p. 104182, Apr. 2021, doi: 10.1016/j.engappai.2021.104182.
2417
25-
Quickstart
26-
**********
18+
Installation
19+
************
20+
21+
**Recommended Installation**
22+
23+
The modern way to install keras2c is via pip:
24+
25+
.. code-block:: bash
2726
28-
For windows, make sure that you have gcc installed. We recommend CYGWIN with make and gcc
27+
pip install keras2c
2928
30-
After cloning the repo, install the necessary packages with ``pip install -r requirements.txt``.
31-
Alternatively, create a conda environment using ``conda env create -f environment.yml``.
29+
To use the original/stable version, use the Release v1.0.2 (https://github.com/PlasmaControl/keras2c/releases/tag/v1.0.2) with the command:
30+
31+
.. code-block:: bash
32+
33+
git clone git@github.com:PlasmaControl/keras2c.git --branch v1.0.2
34+
35+
For Windows, make sure that you have **gcc** installed. We recommend **CYGWIN** with make and gcc.
36+
37+
Quickstart
38+
**********
3239

3340
keras2c can be used from the command line:
3441

@@ -50,21 +57,21 @@ keras2c can be used from the command line:
5057
-t , --num_tests Number of tests to generate. Default is 10
5158
5259
53-
It can also be used with a python environment in the following manner:
60+
It can also be used within a python environment:
5461

5562
.. code-block:: python
5663
5764
from keras2c import k2c
5865
k2c(model, function_name, malloc=False, num_tests=10, verbose=True)
5966
60-
For more information, see `Installation <https://f0uriest.github.io/keras2c/installation.html>`_ and `Usage <https://f0uriest.github.io/keras2c/usage.html>`_
67+
For more information, see `Installation <https://f0uriest.github.io/keras2c/installation.html>`_ and `Usage <https://f0uriest.github.io/keras2c/usage.html>`_
6168

6269

6370
Supported Layers
6471
****************
65-
- **Core Layers**: Dense, Activation, Dropout, Flatten, Input, Reshape, Permute, RepeatVector, ActivityRegularization, SpatialDropout1D, SpatialDropout2D, SpatialDropout3D
72+
- **Core Layers**: Dense, Activation, Dropout, Flatten, Input, Reshape, Permute, RepeatVector, ActivityRegularization, SpatialDropout1D, SpatialDropout2D, SpatialDropout3D
6673
- **Convolution Layers**: Conv1D, Conv2D, Conv3D, Cropping1D, Cropping2D, Cropping3D, UpSampling1D, UpSampling2D, UpSampling3D, ZeroPadding1D, ZeroPadding2D, ZeroPadding3D
67-
- **Pooling Layers**: MaxPooling1D, MaxPooling2D, AveragePooling1D, AveragePooling2D, GlobalMaxPooling1D, GlobalAveragePooling1D, GlobalMaxPooling2D, GlobalAveragePooling2D, GlobalMaxPooling3D,GlobalAveragePooling3D
74+
- **Pooling Layers**: MaxPooling1D, MaxPooling2D, AveragePooling1D, AveragePooling2D, GlobalMaxPooling1D, GlobalAveragePooling1D, GlobalMaxPooling2D, GlobalAveragePooling2D, GlobalMaxPooling3D, GlobalAveragePooling3D
6875
- **Recurrent Layers**: SimpleRNN, GRU, LSTM, SimpleRNNCell, GRUCell, LSTMCell
6976
- **Embedding Layers**: Embedding
7077
- **Merge Layers**: Add, Subtract, Multiply, Average, Maximum, Minimum, Concatenate, Dot
@@ -83,8 +90,6 @@ ToDo
8390
- **Merge Layers**: Broadcasting merge between different sizes
8491
- **Misc**: models made from submodels
8592

86-
87-
8893
Contribute
8994
**********
9095

@@ -97,7 +102,6 @@ License
97102

98103
The project is licensed under the LGPLv3 license.
99104

100-
101105
.. |Codecov| image:: https://codecov.io/gh/f0uriest/keras2c/branch/master/graph/badge.svg
102106
:target: https://codecov.io/gh/f0uriest/keras2c
103107
:alt: Code Coverage

0 commit comments

Comments
 (0)