chameleon

Repository for Meta Chameleon, a mixed-modal early-fusion foundation model from FAIR.

https://github.com/facebookresearch/chameleon

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Repository for Meta Chameleon, a mixed-modal early-fusion foundation model from FAIR.

Basic Info
Statistics
  • Stars: 2,005
  • Watchers: 25
  • Forks: 113
  • Open Issues: 4
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Meta Chameleon

Paper | Blog | Model Checkpoint Download | HuggingFace

This repository contains artifacts for the Meta Chameleon model from FAIR, Meta AI. In this repository is: - Standalone Inference Code — a fast GPU-based inference implementation for running model checkpoints - Input-Output Viewing — a harness for richly viewing multimodal model inputs and outputs with a browser-based tool - Evaluation Prompts — mixed-modal and text-only prompts for human evaluation

System Requirements

Running constituent components for inference and the input-output viewer currently requires a CUDA-capable GPU. If you'd like to run inference on other hardware, other inference implementations, including HuggingFace, are platform agnostic.

Getting Started

First, pip install this repository: sh pip install -U git+https://github.com/facebookresearch/chameleon.git

Alternatively, if you want access to the full visualizer, you'll need to clone this repository (instead of installing), then pip install from the repository root: sh git clone https://github.com/facebookresearch/chameleon.git cd chameleon pip install -e .

Model checkpoints and configs must be downloaded before running inference or the viewer. After requesting model access, run the following script, adding pre-signed download URL you were emailed when prompted: sh python -m chameleon.download_data [pre-signed URL] (you can also paste the command given in the email containing the download link)

Running the Viewer

The viewer visualizes multi-modal model input and output. It is most easily run with docker-compose. You'll need to clone the repository, not just a pip install.

The following runs both the service and viewer interface.

By default, this runs the 7B parameter model. You can change the model_path variable in ./config/model_viewer.yaml to select another model and alter other configuration: sh docker-compose up --build

You can open the viewer at http://localhost:7654/

Running the MiniViewer

The miniviewer is a light weight debug visualizer, that can be run with: sh python -m chameleon.miniviewer This runs the 7B parameter model. To run the 30B model, use the following command: sh python -m chameleon.miniviewer --model-size 30b

You can open the miniviewer at http://localhost:5000/.

License

Use of this repository and related resources are governed by the Chameleon Research License and the LICENSE file.

Citation

To cite the paper, model, or software, please use the below: @article{Chameleon_Team_Chameleon_Mixed-Modal_Early-Fusion_2024, author = {Chameleon Team}, doi = {10.48550/arXiv.2405.09818}, journal = {arXiv preprint arXiv:2405.09818}, title = {Chameleon: Mixed-Modal Early-Fusion Foundation Models}, url = {https://github.com/facebookresearch/chameleon}, year = {2024} }

Owner

  • Name: Meta Research
  • Login: facebookresearch
  • Kind: organization
  • Location: Menlo Park, California

Citation (CITATION.cff)

cff-version: 1.2.0
preferred-citation:
  type: article
  title: 'Chameleon: Mixed-Modal Early-Fusion Foundation Models'
  message: >-
    If you use this software, please cite it using the
    metadata from this file.
  authors:
    - name: Chameleon Team
  doi: "10.48550/arXiv.2405.09818"
  url: 'https://arxiv.org/abs/2405.09818'
  journal: "arXiv preprint arXiv:2405.09818"
  year: 2024
  repository-code: 'https://github.com/facebookresearch/chameleon'
  repository-artifact: >-
    https://ai.meta.com/resources/models-and-libraries/chameleon-downloads/

GitHub Events

Total
  • Issues event: 10
  • Watch event: 245
  • Issue comment event: 8
  • Fork event: 11
Last Year
  • Issues event: 10
  • Watch event: 245
  • Issue comment event: 8
  • Fork event: 11

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 14
  • Total Committers: 8
  • Avg Commits per committer: 1.75
  • Development Distribution Score (DDS): 0.643
Past Year
  • Commits: 14
  • Committers: 8
  • Avg Commits per committer: 1.75
  • Development Distribution Score (DDS): 0.643
Top Committers
Name Email Commits
Jacob Kahn j****1@g****m 5
Andy☼ McSherry☼ a****y@a****m 3
lshamis l****s@g****m 1
Zaid 1****i 1
Karthikpadthe k****e@f****m 1
Kabil Aymen 3****n 1
Alireza Hajebrahimi m****8@y****a 1
Leonid Shamis l****s@m****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 59
  • Total pull requests: 17
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 19 hours
  • Total issue authors: 48
  • Total pull request authors: 8
  • Average comments per issue: 2.58
  • Average comments per pull request: 0.76
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 59
  • Pull requests: 17
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 19 hours
  • Issue authors: 48
  • Pull request authors: 8
  • Average comments per issue: 2.58
  • Average comments per pull request: 0.76
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • MaureenZOU (2)
  • hellangleZ (2)
  • pydemo (2)
  • KL-VC (2)
  • neoyxm (1)
  • 0wwafa (1)
  • developersdigest (1)
  • zsj555 (1)
  • FYYDCC (1)
  • iz2late (1)
  • MeNicefellow (1)
  • zzzqzhou (1)
  • vodp (1)
  • apresence (1)
  • bryanhpchiang (1)
Pull Request Authors
  • jacobkahn (7)
  • andyland (5)
  • lshamis (4)
  • Mclawrenceco (4)
  • iarata (2)
  • Karthikpadthe (2)
  • z44d (1)
  • 2ei (1)
  • LikhonX (1)
  • Kabil-Aymen (1)
Top Labels
Issue Labels
Pull Request Labels
CLA Signed (26)

Dependencies

chameleon/viewer/frontend/package-lock.json npm
  • 490 dependencies
chameleon/viewer/frontend/package.json npm
  • @tailwindcss/typography ^0.5.9 development
  • @types/react ^18.2.15 development
  • @types/react-dom ^18.2.7 development
  • @types/ws ^8.5.9 development
  • @typescript-eslint/eslint-plugin ^6.0.0 development
  • @typescript-eslint/parser ^6.0.0 development
  • @vitejs/plugin-react ^4.0.3 development
  • autoprefixer ^10.4.15 development
  • daisyui ^3.9.2 development
  • eslint ^8.45.0 development
  • eslint-plugin-react-hooks ^4.6.0 development
  • eslint-plugin-react-refresh ^0.4.3 development
  • postcss ^8.4.28 development
  • prettier ^3.0.3 development
  • tailwindcss ^3.3.3 development
  • typescript ^5.0.2 development
  • vite ^4.4.5 development
  • vitest ^0.34.6 development
  • @carbon/icons-react ^11.25.0
  • @lexical/react ^0.12.2
  • axios ^1.4.0
  • lexical ^0.12.2
  • prettier ^3.0.3
  • react ^18.2.0
  • react-cookie ^6.1.1
  • react-daisyui ^4.1.0
  • react-dnd ^16.0.1
  • react-dnd-html5-backend ^16.0.1
  • react-dom ^18.2.0
  • react-dropzone ^14.2.3
  • react-hotkeys-hook ^4.4.1
  • react-markdown ^9.0.1
  • react-router-dom ^6.15.0
  • react-use-websocket ^4.5.0
  • react18-json-view ^0.2.4
  • remark-gfm ^4.0.0
  • unique-username-generator ^1.2.0
  • ws ^8.14.2
  • zod ^3.22.2
  • zustand ^4.4.1
chameleon/viewer/backend/requirements.txt pypi
  • Pillow ==10.0.
  • albumentations ==1.3.1
  • black ==23.7.0
  • einops ==0.7.0
  • fastapi ==0.101.1
  • httpx ==0.24.1
  • hydra-core ==1.3.2
  • ipython *
  • isort ==5.12.0
  • psutil ==5.9.7
  • pudb ==2022.1.3
  • pydantic ==1.10.
  • pylint ==2.17.5
  • pytest ==7.4.0
  • python-multipart ==0.0.6
  • pytorch_lightning ==2.1.2
  • redis ==5.0.1
  • requests ==2.31.
  • rich ==13.5.
  • ruff ==0.1.2
  • submitit ==1.4.2
  • torchvision ==0.16.
  • transformers ==4.36.2
  • typer ==0.9.0
  • uvicorn ==0.23.2
  • websockets ==12.0
  • xformers ==0.0.23
pyproject.toml pypi
  • Pillow ==10.0.*
  • click *
  • flask *
  • flask_socketio *
  • transformers ==4.36.2
  • xformers ==0.0.23