Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dayesouza committed Nov 6, 2024
1 parent 317fae1 commit e14b623
Showing 1 changed file with 40 additions and 19 deletions.
59 changes: 40 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,45 +148,58 @@ flowchart TD

## Diving Deeper

### NGOs
### Getting started

Non-profit organizations can apply for an annual Azure credit grant of $2,000, which can be used to set up and run an instance of the intelligence-toolkit app for your organization.
You can start using the Intelligence Toolkit as either a web application (with a tool called Docker) or a Python package (via PyPI). Choose one of the options below based on your needs.

[Read more about eligibility and registration here](https://www.microsoft.com/en-us/nonprofits/azure)
**Option 1: Using Intelligence Toolkit as a Web Application (via Docker)**

### Getting started
To use the Intelligence Toolkit as a web application, you can download and run it using Docker.

#### Using Intelligence Toolkit as a web application
**1. Install Docker:**

To use Intelligence Toolkit as a web application, you can download and run it using a tool called Docker.
Download and install Docker Desktop from [docker.com](https://www.docker.com/products/docker-desktop/).

- Download, install, and then open the Docker Desktop app: https://www.docker.com/products/docker-desktop/
Start the Docker Desktop app and make sure it’s running before proceeding.

- Open a terminal according to your OS:
**2. Open Terminal:**

- If you are using Windows, search for and open the app `Windows Powershell` in the Windows start menu
Open a terminal according to your OS:

- If you are using Windows, search for and open the app `Windows Powershell` in the Windows start menu.

- If you are using Linux or Mac, search for and open `Terminal`.

- If you are using Linux or Mac, search for and open `Terminal`
**3. Pull the Docker Container:**

- Download a copy of the Intelligence Toolkit application from GitHub by pasting the following command into your terminal and pressing enter:
Download a copy of the Intelligence Toolkit application from GitHub:

`docker pull ghcr.io/microsoft/intelligence-toolkit:latest`

- Once the download is finished, run the Intelligence Toolkit application using Docker by pasting the following command into your terminal and pressing enter:
**Note:** The image is approximately 2GB, so the download may take some time depending on your internet speed.

**4. Run the Docker Container:**

Once the download is finished, run the Intelligence Toolkit application using Docker by pasting the following command into your terminal and pressing enter:

`docker run -d --name intelligence-toolkit -p 80:80 ghcr.io/microsoft/intelligence-toolkit:latest`


**5. Access the Web Application:**

- In your web browser, open [localhost:80](http://localhost:80) to use Intelligence Toolkit

**Note that Docker might sleep and need restarting. In this case, open Docker Desktop, select Container in the left menu, then press play on intelligence-toolkit.**
Open [http://localhost:80](http://localhost:80) in your web browser to start using Intelligence Toolkit.

#### Using Intelligence Toolkit as a Python package
**Note:** Docker Desktop App may enter sleep mode if inactive. In this case, open Docker Desktop, select Container in the left menu, then press play on intelligence-toolkit.

- To use Intelligence Toolkit as a Python package, install it via PyPI:
**Option 2: Using Intelligence Toolkit as a Python Package (via PyPI)**

pip install intelligence-toolkit
If you prefer to use Intelligence Toolkit as a Python package, install it directly from PyPI:

`pip install intelligence-toolkit`

- Find examples in the `example_notebooks` folder of this repository.
After installation, explore the examples in the example_notebooks folder to get started with various functionalities.

<hr>

- To start developing, see [DEVELOPING.md](./DEVELOPING.md).
- To instructions on how to deploy, see [DEPLOYING.md](./DEPLOYING.md).
Expand All @@ -195,6 +208,14 @@ To use Intelligence Toolkit as a web application, you can download and run it us

If you have any questions or need further assistance, you can reach out to the project maintainers at [itkteam@microsoft.com](mailto:itkteam@microsoft.com).

<hr>

### NGOs

Non-profit organizations can apply for an annual Azure credit grant of $2,000, which can be used to set up and run an instance of the intelligence-toolkit app for your organization.

[Read more about eligibility and registration here](https://www.microsoft.com/en-us/nonprofits/azure)

## Trademarks

- This project may contain trademarks or logos for projects, products, or services.
Expand Down

0 comments on commit e14b623

Please sign in to comment.