Skip to content

README.md

Latest commit

 

History

History
98 lines (64 loc) · 2 KB

README.md

File metadata and controls

98 lines (64 loc) · 2 KB

PixCrypt GPT

An AI product for describing product images.

Version 0.1.1

Initial release of the application.

Installation

Option 1: Using uv and Makefile

To get started with the Pixcrypt, follow these steps:

  1. Clone the repository:
   git clone https://github.com/Danselem/pixcrypt.git
   cd nvidia_blueprint/research_assistant
  1. Installing uv

Use the link to install uv depending on your platform.

⚠️ Note: Ensure you have make installed on your PC. If you do not have make installed, kindly follow the instructions for Windows and Linux.

  1. Install dependencies
    make install-python
    make install
  1. Set up environmental variables
    make env

Then fill in the required API keys in the .env file in your project directory.

  1. Start the app
    make run

Option 2: Using pip only

  1. Clone this repository:

    git clone https://github.com/Danselem/pixcrypt.git

  2. Change to the cloned repository directory:

    cd pixcrypt

  3. Create a virtual environment

    python3.10 -m venv .venv

  4. Activate the virtual environment

    source .venv/bin/activate

  5. Install the required Python packages:

    pip install --upgrade pip && pip install -r requirements.txt

Usage

Option 1: Running the Streamlit App Locally

  1. Run the Streamlit app:

    streamlit run app.py &

  2. Open a web browser and navigate to http://localhost:8501 to access the app running inside the container.

  3. Follow the steps in the Streamlit interface to use PixCrypt GPT.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT