feat: docs (#14)

* feat: documentation

* feat: documentation

* feat: rename NeuralNetwork to Sequential

* fix: revert rename NeuralNetwork to Sequential

README.md

@@ -135,7 +135,7 @@ console.log((await net.predict(tensor2D([[1, 1]]))).data);
 
 ### Documentation
 
-The full documentation for Netsaur can be found [here](https://deno.land/x/[email protected].0/mod.ts).
+The full documentation for Netsaur can be found [here](https://deno.land/x/[email protected].2/mod.ts).
 
 ### License
 

deps.ts

@@ -3,6 +3,6 @@ export { Core } from "https://raw.githubusercontent.com/denosaurs/neo/e7f602cd21
 export { WebGPUData } from "https://raw.githubusercontent.com/denosaurs/neo/e7f602cd218fbdb7418e0fca9ac4aba8d6c22d08/backend/webgpu/data.ts";
 export {
   CsvStream,
-} from "https://deno.land/std@0.159.0/encoding/csv/stream.ts";
+} from "https://deno.land/std@0.183.0/encoding/csv/stream.ts";
 export { dlopen } from "https://deno.land/x/[email protected]/mod.ts";
 export type { FetchOptions } from "https://deno.land/x/[email protected]/mod.ts";

src/backend_cpu/backend.ts

@@ -10,6 +10,9 @@ import {
   TrainOptions,
 } from "./util.ts";
 
+/**
+ * CPU Backend.
+ */
 export class CPUBackend {
   config: NetworkConfig;
   library: Library;

src/backend_cpu/mod.ts

@@ -11,7 +11,7 @@ const options: FetchOptions = {
   name: "netsaur",
   url: new URL(import.meta.url).protocol !== "file:"
     ? new URL(
-      "https://github.com/denosaurs/netsaur/releases/download/0.2.0/",
+      "https://github.com/denosaurs/netsaur/releases/download/0.2.2/",
       import.meta.url,
     )
     : "./target/release/",
@@ -68,4 +68,7 @@ export class CPUBackendLoader {
   }
 }
 
+/**
+ * CPU Backend Type.
+ */
 export const CPU = new CPUBackendLoader();

src/backend_cpu/tensor.ts

@@ -2,6 +2,9 @@ import { Rank, Shape, Tensor, TensorData } from "../../mod.ts";
 import { length } from "../core/tensor/util.ts";
 import { BackendType } from "../core/types.ts";
 
+/**
+ * CPU Tensor Backend.
+ */
 export class CPUTensorBackend {
   zeroes<R extends Rank, B extends BackendType>(shape: Shape[R]): Tensor<R, B> {
     return new Tensor(new Float32Array(length(shape)) as TensorData[B], shape);

src/backend_cpu/util.ts

@@ -1,5 +1,8 @@
 import { DataSet, Rank, Shape } from "../../mod.ts";
 
+/**
+ * Train Options Interface.
+ */
 export type TrainOptions = {
   datasets: number;
   inputShape: Shape[Rank];
@@ -8,19 +11,31 @@ export type TrainOptions = {
   rate: number;
 };
 
+/**
+ * Predict Options Interface.
+ */
 export type PredictOptions = {
   inputShape: Shape[Rank];
   outputShape: Shape[Rank];
 };
 
+/**
+ * Encode JSON data.
+ */
 export function encodeJSON(json: unknown) {
   return new TextEncoder().encode(JSON.stringify(json));
 }
 
+/**
+ * Returns the BigInt value of a pointer.
+ */
 export function pointer(arr: BufferSource) {
   return BigInt(Deno.UnsafePointer.value(Deno.UnsafePointer.of(arr)));
 }
 
+/**
+ * Encode datasets.
+ */
 export function encodeDatasets(datasets: DataSet[]) {
   const pointers: bigint[] = [];
   for (const dataset of datasets) {

src/backend_wasm/backend.ts

@@ -8,6 +8,9 @@ import {
 } from "./lib/netsaur.generated.js";
 import { PredictOptions, TrainOptions } from "./utils.ts";
 
+/**
+ * Web Assembly Backend.
+ */
 export class WASMBackend {
   config: NetworkConfig;
   outputShape?: Shape[Rank];

src/backend_wasm/lib/netsaur.generated.js

@@ -1,7 +1,7 @@
 // @generated file from wasmbuild -- do not edit
 // deno-lint-ignore-file
 // deno-fmt-ignore-file
-// source-hash: 7077043632c1986dee512bca3299c31e44fd3bcc
+// source-hash: 6cc9f6f66326aec7fc3ebedaf05c0a2ac31f17ec
 let wasm;
 let cachedInt32Memory0;
 

src/backend_wasm/mod.ts

@@ -7,6 +7,9 @@ import { WASMTensorBackend } from "./tensor.ts";
 import { NetworkJSON } from "../model/types.ts";
 import { instantiate } from "./lib/netsaur.generated.js";
 
+/**
+ * Web Assembly backend instance.
+ */
 export class WASMInstance {
   static initialized = false;
 
@@ -19,6 +22,9 @@ export class WASMInstance {
   }
 }
 
+/**
+ * Web Assembly Backend Loader.
+ */
 export class WASMBackendLoader {
   async setup(silent = false) {
     Tensor.backend = new WASMTensorBackend();
@@ -38,4 +44,7 @@ export class WASMBackendLoader {
   }
 }
 
+/**
+ * Web Assembly Backend Type.
+ */
 export const WASM = new WASMBackendLoader();

src/backend_wasm/tensor.ts

@@ -2,6 +2,9 @@ import { Rank, Shape, Tensor, TensorData } from "../../mod.ts";
 import { length } from "../core/tensor/util.ts";
 import { BackendType } from "../core/types.ts";
 
+/**
+ * Web Assembly Tensor Backend.
+ */
 export class WASMTensorBackend {
   zeroes<R extends Rank, B extends BackendType>(shape: Shape[R]): Tensor<R, B> {
     return new Tensor(new Float32Array(length(shape)) as TensorData[B], shape);

src/backend_wasm/utils.ts

@@ -1,5 +1,8 @@
 import { Rank, Shape } from "../../mod.ts";
 
+/**
+ * Train Options Interface.
+ */
 export type TrainOptions = {
   datasets: number;
   inputShape: Shape[Rank];
@@ -8,6 +11,9 @@ export type TrainOptions = {
   rate: number;
 };
 
+/**
+ * Predict Options Interface.
+ */
 export type PredictOptions = {
   inputShape: Shape[Rank];
   outputShape: Shape[Rank];

src/core/api/error.ts

@@ -1,6 +1,9 @@
 import { BackendType } from "../types.ts";
 import { Rank, Shape, Shape2D } from "./shape.ts";
 
+/**
+ * Incompatible Rank Error is thrown when a tensor is incompatible with a layer.
+ */
 export class IncompatibleRankError extends Error {
   constructor(shape: number, expected: number) {
     super(
@@ -9,12 +12,18 @@ export class IncompatibleRankError extends Error {
   }
 }
 
+/**
+ * Invalid Flatten Error is thrown when a tensor cannot be flattened.
+ */
 export class InvalidFlattenError extends Error {
   constructor(input: Shape[Rank], output: Shape[Rank]) {
     super(`Cannot flatten tensor of shape ${input} to shape ${output}`);
   }
 }
 
+/**
+ * No backend error is thrown when a backend is not initialized.
+ */
 export class NoBackendError extends Error {
   constructor(type: BackendType) {
     super(
@@ -23,12 +32,18 @@ export class NoBackendError extends Error {
   }
 }
 
+/**
+ * Invalid Pool Error is thrown when a tensor cannot be pooled.
+ */
 export class InvalidPoolError extends Error {
   constructor(size: Shape[Rank], stride: Shape2D) {
     super(`Cannot pool shape ${size} with stride ${stride}`);
   }
 }
 
+/**
+ * Invalid Activation Error is thrown when an activation function is invalid.
+ */
 export class ActivationError extends Error {
   constructor(activation: string) {
     super(`Unknown activation function: ${activation}.`);

src/core/api/layer.ts

@@ -1,6 +1,9 @@
 import { Activation, Init, LayerType } from "../types.ts";
 import { Rank, Shape, Shape1D, Shape2D, Shape4D } from "./shape.ts";
 
+/**
+ * Layer is the base type for all layers.
+ */
 export type Layer =
   | { type: LayerType.Dense; config: DenseLayerConfig }
   | { type: LayerType.Activation; config: ActivationLayerConfig }
@@ -9,31 +12,97 @@ export type Layer =
   | { type: LayerType.Flatten; config: FlattenLayerConfig }
   | { type: LayerType.Softmax };
 
+/**
+ * The configuration for a dense layer.
+ */
 export type DenseLayerConfig = {
+  /**
+   * The type of initialization to use.
+   */
   init?: Init;
+
+  /**
+   * The size of the layer.
+   */
   size: Shape1D;
+
+  /**
+   * The activation function to use.
+   */
   activation?: Activation;
 };
 
+/**
+ * The configuration for an activation layer.
+ */
 export type ActivationLayerConfig = {
+  /**
+   * The activation function to use.
+   */
   activation: Activation;
 };
 
+/**
+ * The configuration for a convolutional layer.
+ */
 export type ConvLayerConfig = {
+  /**
+   * The type of initialization to use.
+   */
   init?: Init;
+
+  /**
+   * The activation function to use.
+   */
   activation?: Activation;
+
+  /**
+   * The kernel to use.
+   */
   kernel?: Float32Array;
+
+  /**
+   * The size of the kernel.
+   */
   kernelSize: Shape4D;
+
+  /**
+   * The optional padding to use.
+   */
   padding?: number;
+
+  /**
+   * Whether or not to not use bias.
+   */
   unbiased?: boolean;
+
+  /**
+   * The optional strides to use.
+   */
   strides?: Shape2D;
 };
 
+/**
+ * The configuration for a pooling layer.
+ */
 export type PoolLayerConfig = {
+  /**
+   * The optional strides to use.
+   */
   strides?: Shape2D;
+
+  /**
+   * The mode to use for the pool layer.
+   */
   mode?: "max" | "avg";
 };
 
+/**
+ * The configuration for a flatten layer.
+ */
 export type FlattenLayerConfig = {
+  /**
+   * The size of the layer.
+   */
   size: Shape[Rank];
 };