Skip to content

Commit afa4c2e

Browse files
docs: fix Quick Start example and config field names
- Removed reference to non-existent examples/quick_start.ef file - Fixed config field names from 'model_path'/'output_path' to 'model'/'output' to match validator requirements - Added clarification to create my_config.ef in project root directory The README referenced examples/quick_start.ef which doesn't exist and would be ignored by .gitignore rules. Also, the example configs used 'model_path' and 'output_path' but the validator expects 'model' and 'output', causing validation failures for users following the docs. Tested and verified config now loads successfully.
1 parent 145d68f commit afa4c2e

1 file changed

Lines changed: 4 additions & 14 deletions

File tree

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,19 +74,9 @@ 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
88-
89-
Create a file `my_config.ef`:
79+
Create a file `my_config.ef` in the project root directory:
9080

9181
```
9282
model = "path/to/your/model.tflite"
@@ -108,7 +98,7 @@ If you prefer not to install, set `PYTHONPATH`:
10898

10999
```bash
110100
export PYTHONPATH=$(pwd)/src
111-
python -m edgeflow.compiler.edgeflowc examples/quick_start.ef
101+
python -m edgeflow.compiler.edgeflowc my_config.ef
112102
```
113103

114104
## Usage
@@ -264,4 +254,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on how to contrib
264254
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
265255

266256
## Security Notes
267-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
257+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)