Skip to main content
The help command provides comprehensive information about available Neurenix CLI commands and their usage.

Usage

Arguments

Examples

General help

Help for specific command

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

Get help for run command

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

Get help for hardware command

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:
Examples:

Error Handling

Unknown command

Quick Reference

Get started

Common workflows

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:

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:

Tips

1. Start with general help

2. Explore specific commands

3. Use —help for details

4. Combine with examples

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

5. Check version info

See Also