Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/MilesONerd/neurenix/llms.txt

Use this file to discover all available pages before exploring further.

The help command provides comprehensive information about available Neurenix CLI commands and their usage.

​
Usage

neurenix help [command]

​
Arguments

ArgumentTypeDescription
commandstringSpecific command to get help for (optional)

​
Examples

​
General help

neurenix help

Neurenix CLI - Command Line Interface for the Neurenix Framework

Usage: neurenix <command> [<args>]

Available commands:
  init         - Initialize a new Neurenix project with a standard folder structure, configuration files, and optional dataset
  run          - Run a Neurenix model training script with specified configuration options
  save         - Save the current project state, including model, configurations, and data
  predict      - Make predictions using a trained model
  eval         - Evaluate a trained model with specific metrics
  export       - Export a trained model to a specific format (ONNX, TorchScript, etc.)
  hardware     - Manage hardware settings, including auto-selection, device information, and benchmarking
  preprocess   - Preprocess input data for model training
  monitor      - Monitor model training in real-time
  optimize     - Optimize a model by adjusting hyperparameters or applying techniques like quantization
  dataset      - Manage datasets for training and evaluation
  serve        - Serve a trained model as a RESTful API
  help         - Display help information about available commands

For more information about a specific command, use:
  neurenix help <command>
  neurenix <command> --help

​
Help for specific command

neurenix help init
This displays detailed help for the init command, equivalent to running: 
neurenix init --help

​
Get help for run command

neurenix help run
Displays usage information, options, and examples for the run command.

​
Get help for hardware command

neurenix help hardware
Shows available actions and options for hardware management.

​
Available Commands

All Neurenix CLI commands that can be queried with help:

​
Project Management

  • init - Initialize new projects
  • save - Save project state

​
Training & Evaluation

  • run - Execute training scripts
  • eval - Evaluate model performance
  • monitor - Monitor training progress

​
Inference

  • predict - Generate predictions
  • serve - Deploy models as APIs

​
Model Operations

  • export - Export to different formats
  • optimize - Optimize model performance

​
Data Management

  • dataset - Manage datasets
  • preprocess - Preprocess data

​
System

  • hardware - Configure hardware settings
  • help - Display help information

​
Using —help Flag

Every command supports the --help flag for inline help: 
neurenix <command> --help
Examples: 
neurenix init --help
neurenix run --help
neurenix predict --help
neurenix dataset --help

​
Error Handling

​
Unknown command

neurenix help unknown_command

Error: Unknown command 'unknown_command'

Available commands:
  init         - Initialize a new Neurenix project with a standard folder structure, configuration files, and optional dataset
  run          - Run a Neurenix model training script with specified configuration options
  save         - Save the current project state, including model, configurations, and data
  ...

​
Quick Reference

​
Get started

# See all commands
neurenix help

# Learn about project initialization
neurenix help init

# Learn about training
neurenix help run

​
Common workflows

# Project setup help
neurenix help init
neurenix help dataset
neurenix help preprocess

# Training help
neurenix help run
neurenix help monitor
neurenix help save

# Deployment help
neurenix help optimize
neurenix help export
neurenix help serve

​
Help Output Format

Each command’s help includes:
  1. Description: What the command does
  2. Usage: Basic syntax
  3. Arguments: Required and optional arguments
  4. Options: Available flags and parameters
  5. Examples: Common usage patterns

​
Interactive Help

For the most up-to-date help information, use the --help flag: 
neurenix init --help
neurenix run --help
neurenix predict --help

​
Additional Resources

Beyond the CLI help:

​
Documentation

Visit the full documentation for detailed guides and tutorials:

​
Command Documentation

Detailed documentation for each command:

​
Examples

Check out example projects and workflows: 
# View example in documentation
neurenix help init
neurenix help run

​
Tips

​
1. Start with general help

neurenix help

​
2. Explore specific commands

neurenix help <command>

​
3. Use —help for details

neurenix <command> --help

​
4. Combine with examples

The help output includes practical examples you can copy and modify.

​
5. Check version info

neurenix --version

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us