Repository files navigation

This is the hyperparam cli tool.

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

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.parquetnpx hyperparam directory/npx hyperparam https://hyperparam-public.s3.amazonaws.com/bunnies.parquet

To start a chat with hyperparam:

npx hyperparam chat

Install for all users:

sudo npm i -g hyperparam

Now you can just run:

hyperparam

or:

hyp

To develop the CLI locally:

npm inpm run dev

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

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

Thehyperparam package also includes a library that can be used in other applications. The library is in thelib/ 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";exportdefaultdefineConfig({  ...optimizeDeps:{exclude:["hyperparam"],},});