Skip to content

Commit

Permalink
Addressing feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Victoria Godsoe <[email protected]>
  • Loading branch information
vgodsoe committed Jan 29, 2025
1 parent b34aec2 commit f2717a4
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ DigestAI

<div align="left">

DigestAI is a model analysis tool that extracts insights, enables optimization, and supports direct modifications, making your workflow efficient and effective

## Table of Contents
- [Key Features](#key-features)
Expand All @@ -43,7 +42,17 @@ DigestAI is a model analysis tool that extracts insights, enables optimization,

# Key Features

<< FIND THEM OUT FROM PHIL>>
- Single Model Analysis:
- Analyze individual models to extract parameters, FLOPs, protobuf metadata, histograms, model similarity, and IO tensors.
- Freeze dynamic input shapes to ensure consistent calculations and analysis.
- Multi-Model Analysis:
- Compare high-level statistics of multiple models side by side.
- Batch process single model reports for efficient analysis.
- Reporting and Export:
- Save all extracted statistics into comprehensive reports and CSV files for easy sharing and collaboration.
- Open and view shared reports directly within the GUI for seamless integration.

For more insights on Digest AI, see our announcement blog [here](https://www.amd.com/en/developer/resources/technical-articles/digest-ai-model-ingestion-and-analysis-tool.html).


# Getting Started
Expand Down Expand Up @@ -81,7 +90,7 @@ DigestAI is a model analysis tool that extracts insights, enables optimization,

# Digest AI User Guide

![Digest AI](img\digest.gif)
<img src="https://github.com/onnx/digestai/blob/main/img/digest.gif" width="800" alt="Digest AI Demo"/>

### Opening and Analyzing a Model

Expand Down Expand Up @@ -142,6 +151,8 @@ Digest AI includes an API for ingesting, modifying, and analyzing machine learni
- Analyzes a single model or multiple models in a directory.
- Generates reports on model summary, node lists, node type counts, and node shape counts.

The `analysis.py` script can be found in the `examples/` directory.

```python
# Single model
python analysis.py /path/to/model.onnx /path/to/output/directory
Expand Down Expand Up @@ -213,6 +224,10 @@ pip install pytest
pytest test/test_gui.py
```
## Contact
To get in touch, please reach out to us at [[email protected]](mailto:[email protected]).
## License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE.txt) file for details.
Expand Down

0 comments on commit f2717a4

Please sign in to comment.