Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 5.81 KB

README.md

File metadata and controls

109 lines (77 loc) · 5.81 KB
Raw

WindowsAI hero image

AI Dev Gallery (Preview)

Important

This app is currently in public preview. We are looking for feedback. Please let us know what you think by creating an issue.

The AI Dev Gallery is an app designed to help Windows developers integrate AI capabilities within their own apps and projects. The app contains the following:

  • Interactive samples powered by local AI models
  • Explore, download, and run models from Hugging Face and GitHub
  • The ability to view source code and export Visual Studio projects for each sample


AI Dev Gallery

🚀 Getting Started

Follow the following guide to install the AI Dev Gallery locally:

1. Set up the Environment

⚠️ Note: The AI Dev Gallery requires Visual Studio 2022 or later to build and Windows 10 or later to execute. If you're building an app with WinUI and Windows App SDK for the first time, follow the installation instructions here).

Required Visual Studio components:

  • Windows application development

2. Clone the Repository

git clone https://github.com/microsoft/AI-Dev-Gallery.git

3. Open .sln with Visual Studio and Build!

.\AIDevGallery.sln

Press F5 to run AI Dev Gallery!

⚠️ Note: Having issues installing the app on your machine? Let us know by opening an issue and our team will do our best to help you.


💻 Device Requirements

  • Minimum OS Version: Windows 10, version 1809 (10.0; Build 17763)
  • Architecture: x64, ARM64
  • Memory: At least 16 GB is recommended
  • Disk Space: At least 20GB free space is recommended
  • GPU: 8GB of VRAM is recommended for running samples on the GPU

👏 Contribute to AI Dev Gallery

Any samples or docs improvements you'd like to see? We're always looking for a helping hand. Feel free to open an issue to start the discussion, or even better, create a PR with the change you'd like to see!


❓ FAQs

  • Q: Is a Microsoft account necessary to use the app?
    • A: No, the app does NOT require a Microsoft account for use.
  • Q: Can I use the app without an internet connection?
    • A: Yes, the app works offline since the AI models are downloaded locally. However, you will need to be online to download additional AI models from Hugging Face or GitHub.
  • Q: What AI models are available in the app?
    • A: The app features popular open source models and will eventually include APIs from the Windows Copilot Runtime. When executing a sample, you can select which model you want to use.
  • Q: Is the app's source code accessible? Can I contribute new samples?
    • A: Yes, the app is completely open-source, and its code is accessible on GitHub. Feel free to contribute by filing an issue, or submitting a PR and one of our moderators will review it.
  • Q: Where can I provide feedback?
    • A: Feel free to give us feedback or open an issue on our GitHub repository.
  • Q: Do I need to run the app just to try a single sample?
    • A: Yes, the app is required to run any sample. However, once you've downloaded a model for a sample via the app, you can export the sample as a Visual Studio project and run it independently from there.

✨ Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.


📚 Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.


🔔 Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.


📢 Privacy Statement

The application logs basic telemetry. Please read the Microsoft privacy statement for more information.