Skip to content

Commit ac74538

Browse files
Merge pull request #33 from me-jain-anurag/fix/readme-example-documentation
docs: fix Quick Start example and config field names
2 parents 145d68f + ef58811 commit ac74538

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -74,19 +74,11 @@ edgeflow --help
7474

7575
> **Note**: You may see a warning about missing 'dynamic_device_profiles'. This is expected and doesn't affect functionality.
7676
77-
### 3. Run Example
77+
### 3. Create Your Own Config
7878

79-
```bash
80-
# View the example configuration
81-
cat examples/quick_start.ef
82-
83-
# Run the compiler (note: requires a .tflite model file)
84-
edgeflow examples/quick_start.ef
85-
```
86-
87-
### 4. Create Your Own Config
79+
Create a file `my_config.ef` in the project root directory:
8880

89-
Create a file `my_config.ef`:
81+
> **Note:** You'll need an actual TensorFlow Lite model file (`.tflite`). You can also use `.h5`, `.onnx`, or `.keras` format models.
9082
9183
```
9284
model = "path/to/your/model.tflite"
@@ -108,7 +100,7 @@ If you prefer not to install, set `PYTHONPATH`:
108100

109101
```bash
110102
export PYTHONPATH=$(pwd)/src
111-
python -m edgeflow.compiler.edgeflowc examples/quick_start.ef
103+
python -m edgeflow.compiler.edgeflowc my_config.ef
112104
```
113105

114106
## Usage

0 commit comments

Comments
 (0)