rustframe/docs/src/introduction.md
2025-08-04 00:29:13 +01:00

1.7 KiB
Raw Blame History

Introduction

📚 Docs | 🐙 GitHub | 🦀 Crates.io | 🔖 docs.rs

Welcome to the Rustframe User Guide. Rustframe is a lightweight dataframe and math toolkit for Rust written in 100% safe Rust. It focuses on keeping the API approachable while offering handy features for small analytical or educational projects.

Rustframe bundles:

  • columnlabelled frames built on a fast columnmajor matrix
  • familiar elementwise math and aggregation routines
  • a growing compute module for statistics and machine learning
  • utilities for dates and random numbers
# extern crate rustframe;
use rustframe::{frame::Frame, matrix::{Matrix, SeriesOps}};

let data = Matrix::from_cols(vec![vec![1.0, 2.0], vec![3.0, 4.0]]);
let frame = Frame::new(data, vec!["A", "B"], None);

// Perform column wise aggregation
assert_eq!(frame.sum_vertical(), vec![3.0, 7.0]);

Resources

This guide walks through the main building blocks of the library. Each chapter contains runnable snippets so you can follow along:

  1. Data manipulation for loading and transforming data
  2. Compute features for statistics and analytics
  3. Machine learning for predictive models
  4. Utilities for supporting helpers and upcoming modules