hyperparam

This is the hyperparam cli tool.

The hyperparam cli tool is for viewing arbitrarily large datasets in the browser.

Viewer

To open a file browser in your current local directory run:

npx hyperparam

You can also pass a specific file, folder, or url:

npx hyperparam example.parquet
npx hyperparam directory/
npx hyperparam https://hyperparam-public.s3.amazonaws.com/bunnies.parquet

Chat

To start a chat with hyperparam:

npx hyperparam chat

Installation

Install for all users:

sudo npm i -g hyperparam

Now you can just run:

hyperparam

or:

hyp

Developers

To develop the CLI locally:

npm i
npm run dev

The application will be rebuild automatically when you make changes, and the browser will refresh.

Library and application

Hyperparam is an application that relies on node.js scripts in the bin/ directory and serves the static web application built in the dist/ directory.

The hyperparam package also includes a library that can be used in other applications. The library is in the lib/ directory. For example:

import { asyncBufferFrom, AsyncBufferFrom, parquetDataFrame } from "hyperparam";

If you encounter any issues with the web worker, you might have to configure your bundler. For example, in Vite, you can use the following configuration:

import { defineConfig } from "vite";
export default defineConfig({
  ...
  optimizeDeps: {
    exclude: ["hyperparam"],
  },
});