Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update models info #150

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Update models info #150

merged 1 commit into from
Jan 21, 2025

Conversation

tunmx
Copy link
Member

@tunmx tunmx commented Jan 21, 2025

No description provided.

Copy link

devloai bot commented Jan 21, 2025

Automatic code review is enabled for this repository. Reviewing this PR now.

@tunmx tunmx merged commit 99d8ddd into master Jan 21, 2025
13 checks passed
Copy link

@devloai devloai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reviewed the README updates and found several areas that need attention. The main concerns are: accuracy of model update dates, duplicate warning messages, and opportunities to improve both warning messages and code examples. Please address these issues to ensure the documentation is accurate, clear, and helpful for users.

@@ -95,6 +95,15 @@ cv2.waitKey(0)
cv2.destroyAllWindows()
```

⚠️The project is currently in a rapid iteration phase, **before each update**, please pull the latest model from the remote side!
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider making the warning message more specific about what might break if models are not updated. For example: "⚠️The project is currently in a rapid iteration phase. To ensure compatibility with the latest SDK features and bug fixes, before each update please pull the latest model from the remote side!"


```python
import inspireface

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding error handling to the model update example to make it more robust. Here's an improved version:

import inspireface

try:
    for model in ["Pikachu", "Megatron"]:
        if inspireface.pull_latest_model(model):
            print(f"Successfully updated {model} model")
        else:
            print(f"Failed to update {model} model")
except Exception as e:
    print(f"Error updating models: {e}")

@@ -129,6 +138,8 @@ You can download the model package files containing models and configurations ne

You can use the **command/download_models_general.sh** command to download resource files, which will be downloaded to the **test_res/pack** directory. This way, when running the Test program, it can access and read the resource files from this path by default.

⚠️The project is currently in a rapid iteration phase, **before each update**, please pull the latest model from the remote side!
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This warning message is duplicated from above. Consider removing this duplicate and keeping only the first instance with the Python example, or if both locations need a warning, reference the Python example here: "⚠️ Remember to update your models as described in the Quick Start section above."

| Gundam-RV1109 | RKNPU | Supports RK1109 and RK1126 | Jul 17, 2024 | [Download](https://github.com/HyperInspire/InspireFace/releases/download/v1.x/Gundam_RV1109) |
| Gundam-RV1106 | RKNPU | Supports RV1103 and RV1106 | Jan 13, 2025 | [Download](https://github.com/HyperInspire/InspireFace/releases/download/v1.x/Gundam_RV1106) |
| Gundam-RK356X | RKNPU | Supports RK3566 and RK3568 | Jan 13, 2025 | [Download](https://github.com/HyperInspire/InspireFace/releases/download/v1.x/Gundam_RK356X) |
| Pikachu | CPU | Lightweight edge-side models | Jan 21, 2025 | [Download](https://github.com/HyperInspire/InspireFace/releases/download/v1.x/Pikachu) |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The update dates for all models have been changed to Jan 21, 2025, which matches the latest changelog entry. However, if not all models were actually updated, consider keeping their original update dates to avoid confusion. Only update the dates for models that received actual changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant