Installation - krishanth7/EveryO GitHub Wiki

Installation

EveryO โ€” Official Installation & Environment Configuration Guide

Prepare ยท Install ยท Configure ยท Verify

Python EveryO License

Install EveryO and prepare a reliable Python machine learning development environment.

Home ยท Getting Started ยท Quick Start ยท Repository


Maintained By & Owner: EveryO Contributors & @krishanth7

Important

Installation Overview

EveryO requires Python 3.9 or newer. The standard installation uses NumPy-based computation and does not require a GPU.

Optional integrations may require additional dependencies, compatible hardware, and environment-specific configuration.


Table of Contents

  1. System Requirements
  2. Installation Methods
  3. Windows Installation
  4. Linux Installation
  5. macOS Installation
  6. Optional Dependencies
  7. CUDA Configuration
  8. Installation Verification
  9. Development Installation
  10. Troubleshooting
  11. Next Steps

1. System Requirements

Component Requirement
Python 3.9 or newer
Package Manager pip
Git Required for cloning
Primary Backend NumPy
Visualization Matplotlib
GPU Optional
Operating System Compatible Windows, Linux, or macOS environment

Verify Python

python --version

On systems using python3:

python3 --version

Verify pip

python -m pip --version

Verify Git

git --version

Note

Operating-system compatibility depends on the installed Python version, dependency availability, and optional backend requirements.


2. Installation Methods

EveryO supports installation from its GitHub source repository.

2.1 Clone the Repository

git clone https://github.com/krishanth7/EveryO.git
cd EveryO

2.2 Standard Installation

python -m pip install -e .

This installs EveryO in editable mode, making it suitable for local development and experimentation.

2.3 Development Installation

python -m pip install -e ".[dev]"

This includes the project's declared development dependencies.


3. Windows Installation

Step 1 โ€” Install Python

Download Python from:

https://www.python.org/downloads/

Ensure Python is accessible from your terminal.

Step 2 โ€” Clone EveryO

Open PowerShell:

git clone https://github.com/krishanth7/EveryO.git
cd EveryO

Step 3 โ€” Create a Virtual Environment

python -m venv .venv

Step 4 โ€” Activate the Environment

.\.venv\Scripts\Activate.ps1

If PowerShell prevents script execution, use Command Prompt activation instead:

.venv\Scripts\activate.bat

Step 5 โ€” Install EveryO

python -m pip install --upgrade pip
python -m pip install -e .

Step 6 โ€” Verify

everyo info
everyo doctor

4. Linux Installation

Step 1 โ€” Verify Python

python3 --version

Ensure the Python virtual environment module and pip are available for your distribution.

Step 2 โ€” Clone EveryO

git clone https://github.com/krishanth7/EveryO.git
cd EveryO

Step 3 โ€” Create and Activate Environment

python3 -m venv .venv
source .venv/bin/activate

Step 4 โ€” Install

python -m pip install --upgrade pip
python -m pip install -e .

Step 5 โ€” Verify

everyo info
everyo doctor

5. macOS Installation

Step 1 โ€” Verify Python

python3 --version

Step 2 โ€” Clone the Repository

git clone https://github.com/krishanth7/EveryO.git
cd EveryO

Step 3 โ€” Create a Virtual Environment

python3 -m venv .venv
source .venv/bin/activate

Step 4 โ€” Install EveryO

python -m pip install --upgrade pip
python -m pip install -e .

Step 5 โ€” Verify

everyo info
everyo doctor

Note

CUDA acceleration generally requires a supported NVIDIA GPU environment and is not available on current Apple Silicon Macs through NVIDIA CUDA.


6. Optional Dependencies

EveryO declares optional dependency groups for additional functionality.

Extra Purpose Installation
dev Testing and development pip install -e ".[dev]"
tensorflow TensorFlow integration pip install -e ".[tensorflow]"
onnx ONNX functionality pip install -e ".[onnx]"
yaml YAML support pip install -e ".[yaml]"
cuda CUDA build dependencies pip install -e ".[cuda]"

Install Multiple Extras

python -m pip install -e ".[dev,onnx,yaml]"

Optional dependency installation does not guarantee compatibility with every operating system or Python version.


7. CUDA Configuration

CUDA is an optional acceleration path.

Prerequisites

Depending on the EveryO CUDA implementation and build configuration, requirements may include:

  • Compatible NVIDIA GPU.
  • Supported GPU driver.
  • CUDA toolkit.
  • Native compilation toolchain.
  • Required Python build dependencies.

Install Declared CUDA Dependencies

python -m pip install -e ".[cuda]"

Check NVIDIA GPU Availability

On supported NVIDIA systems:

nvidia-smi

Warning

The cuda extra alone does not compile, configure, or validate every CUDA component. Follow the repository's CUDA build instructions and test the resulting backend on the intended hardware.


8. Installation Verification

8.1 Check Package Metadata

python -m pip show everyo

8.2 Verify Python Import

python -c "import everyo; print('EveryO import successful')"

8.3 Inspect CLI Information

everyo info

8.4 Run Environment Diagnostics

everyo doctor

8.5 Inspect Available Commands

everyo --help

Verification Checklist

  • Python 3.9 or newer is installed.
  • Virtual environment is configured.
  • EveryO installation completes successfully.
  • Python import succeeds.
  • CLI commands execute.
  • Required optional dependencies are installed.
  • Hardware-specific functionality is validated separately.

9. Development Installation

For contributors, install the development dependencies:

python -m pip install -e ".[dev]"

Run Tests

python -m pytest

Run Linting

ruff check .

Verify Formatting

ruff format --check .

Some tests require optional dependencies or specific hardware and may be skipped in unsupported environments.

For contribution standards, read:

CONTRIBUTING.md


10. Troubleshooting

Python is not recognized

Verify Python installation and the configured executable path.

On Linux or macOS, try python3.

No module named everyo

Activate the intended virtual environment and reinstall:

python -m pip install -e .
everyo command not found

Confirm the package is installed and the environment's executable directory is active.

python -m pip show everyo
Optional dependency missing

Install the appropriate optional dependency group.

Example:

python -m pip install -e ".[onnx]"
CUDA backend unavailable

Check GPU availability, driver compatibility, CUDA toolkit installation, and native extension build requirements.

CUDA functionality must be verified independently of CPU functionality.

Tests fail or are skipped

Inspect the failure output, dependency configuration, and relevant pytest markers.

Skipped tests do not establish that the skipped functionality passed validation.


11. Next Steps

Once installation is complete, continue your EveryO learning journey.

Page Description
Home Return to the Wiki homepage
Getting Started Review developer onboarding
Quick Start Begin working with EveryO
Tensor Engine Explore tensor operations
Automatic Differentiation Understand gradients
Framework Architecture Explore internal design
API Reference Review public interfaces

Some linked Wiki pages may not yet exist.


Installation Guide โ€” Complete

Your next step: Quick Start โ†’


EveryO โ€” Open Machine Learning. Built for Developers.

Maintained By & Owner:
EveryO Contributors & @krishanth7

MIT Licensed ยท Open Source ยท Community Driven

ยฉ 2026 EveryO Contributors

โš ๏ธ **GitHub.com Fallback** โš ๏ธ