Skip to main content

A Python package to run Farsight in your computational notebooks.

Project description

Farsight Farsight logo.

Github Actions Status license npm pypi Open In Colab

In situ interactive widgets for responsible AI 🌱

🚀 Farsight Demo 📺 Demo Video

What is Farsight?

Farsight is a collection of in situ interactive widgets that help large language model (LLM) prompt creators to envision potential harms associated with their AI applications. With a novel in situ design, contextual AI incident feed, and human-AI collaborative harm envisioning, Farsight empowers prompt creators with diverse backgrounds to be more mindful of responsible AI during early AI prototyping.

Widgets
1️⃣ Alert Symbol Alert users with potential risks of their prompts and AI applications
2️⃣ Incident Panel Relevant cautionary tales for users' AI applications
3️⃣ Use Case Panel LLM-generated diverse use cases, stakeholders, and harms
4️⃣ Harm Envisioner Human-AI collaborative harm envisioning tool
Distributions
📦 Live Demo Try Farsight with Gemini Pro and GPT-3.5
📦 Chrome Extension Google AI Studio support
📦 Python Package Computational notebook support (Jupyter, Colab, VS Code notebook)

Demo Video

Click to see the demo video!

Get Started

Live Demo

For a live demo, visit: https://PAIR-code.github.io/farsight/.

Computational Notebook

If you use computational notebooks (e.g., Jupyter Notebook, JupyterLab, Google Colab, VS Code Notebook), you can easily use Farsight via its Python Package. We recommend using StickyLand to enable sticky cells.

Visit this Colab Notebook for a demo.

# Install Farsight
!pip install farsight

prompt = "Translate a sentence from English to French."

# Alert Symbol
farsight.symbol(prompt)

# Awareness Sidebar
farsight.sidebar(prompt)

# Harm Envisioner
farsight.envision(prompt)

Google AI Studio

If you use Google AI Studio to prototype AI applications, you can manually install our Chrome Extension package from the latest release.

  1. Download farsight.crx
  2. Open chrome://extensions/ in Chrome
  3. Drag farsight.crx into the page
  4. Visit Google AI Studio and you will see Farsight :)

Integrating Farsight into Prompting Tools

If you are a developer of web-based prompting tools, you can easily integrate different Farsight widgets into your tool regardless of your development stacks (e.g., React, Svelte, or Vanilla JS).

First, install Farsight's JavaScript package:

npm install --save-dev @xiaohk/farsight

Then, you can use Farsight as Web Components.

JavaScript:

import '@xiaohk/farsight';
import {
  FarsightContainer,
  FarsightContainerLite,
  FarsightContainerSignal
} from '@xiaohk/farsight';

HTML:

<farsight-container-signal
  prompt="Translate a sentence from English to French"
></farsight-container-signal>

Developing Farsight

Clone or download this repository:

git clone git@github.com:PAIR-code/farsight.git

Install the dependencies:

npm install

Then run Farsight:

npm run dev

Navigate to localhost:3000. You should see Farsight running in your browser :)

How is Farsight Built?

Farsight is a collection of Web Components that developers can easily integrate into their web apps regardless of their development stack (e.g., Angular, React, Svelte). Farsight is written in TypeScript using LIT Element as a framework. Farsight uses D3.js to implement the interactive tree visualization. The relevant AI incidents are from the AI Incident Database, and the harm category is from the sociotechnical harm taxonomy. The computational notebook support is enabled by NOVA.

Credits

Led by Jay Wang, Farsight is a result of a collaboration between researchers from Google Research, Georgia Tech, eBay, and Emory University. Farsight is created by Jay Wang, Chinmay Kulkarni, Lauren Wilcox, Mike Terry, and Michael Madaio.

License

Contact

If you have any questions, feel free to open an issue or contact Jay Wang.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

farsight-0.1.5.tar.gz (876.3 kB view details)

Uploaded Source

Built Distribution

farsight-0.1.5-py2.py3-none-any.whl (884.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file farsight-0.1.5.tar.gz.

File metadata

  • Download URL: farsight-0.1.5.tar.gz
  • Upload date:
  • Size: 876.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for farsight-0.1.5.tar.gz
Algorithm Hash digest
SHA256 47860151d96e7800239407809162dd9690ff6b64049cc7ab0539216265b5f270
MD5 e379554b9be7ecc672705d8beb93bd29
BLAKE2b-256 a21df8940e19bf00618d710302aff5c527b3569cbf0e9eb84565080424983373

See more details on using hashes here.

File details

Details for the file farsight-0.1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: farsight-0.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 884.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for farsight-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d9b9f31e58bd476ecdbd6ea9aac399f0dee41150d8f04a77795210255e438028
MD5 7c8ad7967ce9321b59833ad0645164cc
BLAKE2b-256 66b1277eae56847e824a4e0e6d5665f617b3a6e5c19589421dff42d5bed74fd8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page