The XAI Image Explainer project is a unique venture aimed at creating a user-friendly and interactive desktop application that enhances the interpretability of machine learning models, particularly in image classification. The primary goal is to provide users with the ability to understand the decision-making process behind machine learning model predictions.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
This guide will walk you through the steps to set up your development environment for your project. Before you begin, ensure you have the following prerequisites:
- Microsoft Visual Studio 2019
- Docker Desktop
- XAI Docker Image
- NVIDIA Graphics Card with Appropriate Driver
-
Download Visual Studio 2019:
- Go to the official Visual Studio download page: Visual Studio 2019 Downloads.
- Click on the "Download Visual Studio" button.
-
Choose an Edition:
- Select the edition that best fits your needs (e.g., Community, Professional, or Enterprise). You can choose the free Community edition if it suits your requirements.
-
Run the Installer:
- Once the installer is downloaded, run it.
-
Select Workloads:
- During the installation process, you will be asked to select workloads. Choose the workloads that suit your development needs, such as .NET desktop, ASP.NET, Python, etc.
-
Select Individual Components (Optional):
- Customize the installation by selecting individual components, additional tools, or features that you may require.
-
Install:
- After making your selections, click the "Install" button to start the installation.
-
Follow Setup Wizard:
- Follow the setup wizard's instructions to complete the installation.
-
Activation (if required):
- Depending on the edition you chose, you may need to activate Visual Studio. Follow the on-screen instructions for activation.
-
Download Docker Desktop:
- Go to the official Docker Desktop website: Docker Desktop for Windows.
- Click on the "Get Docker Desktop for Windows" button to download the installer.
-
Run the Installer:
- Once the installer is downloaded, run it.
-
Follow Installation Steps:
- Follow the installation steps provided by the Docker Desktop installer. These steps may include agreeing to the license, choosing installation options, and configuring Docker settings.
-
Log in to Docker (if required):
- If prompted, log in to your Docker account or create one.
-
Enable Hyper-V (Windows Pro/Enterprise Only):
- Docker Desktop for Windows requires Hyper-V to be enabled. If your system is running Windows Pro or Enterprise, ensure that Hyper-V is enabled in your system settings. You may need to restart your computer after enabling Hyper-V.
-
Configure Docker Desktop to Start on Login :
- After installation, open Docker Desktop.
- Click on the Docker Desktop icon in the system tray.
- In the menu, go to "Settings."
- In the Settings, navigate to "General."
- Check the option that says "Start Docker Desktop when you log in."
- This will ensure Docker Desktop launches automatically each time you log in.
-
Start Docker Desktop:
- After the installation and configuration are complete, start Docker Desktop. It will run in the background and provide access to Docker containers.
Now, Docker Desktop will automatically start when you log in, ensuring a seamless development experience. You have successfully installed and configured Docker Desktop for your project.
You have now successfully installed Microsoft Visual Studio 2019 and Docker Desktop. These tools will allow you to set up your development environment for your project.
-
Obtain the XAI Docker Image:
- Obtain the XAI Docker Image from the source you have. You might have received a specific image name or source location.
-
Pull the XAI Docker Image:
- Open a command prompt or terminal.
-
Run the following command to pull the XAI Docker Image:
docker pull darrick1103/xai
-
Change the Docker Image name to xai:
docker tag darrick1103/xai:latest xai:latest
Now that you have your development environment set up, you're ready to begin your project. Refer to the documentation provided with your XAI Docker Image for further steps.
Please make sure your NVIDIA graphics card and its driver are also properly set up if required for your project.
Happy coding!