mkdocs.yml

nav:
  - APIs:
    - Cli:
      - Cli: generated-cli-cli.md
    - Data Preprocessing:
      - Processor: generated-data_preprocessing-_processor.md
    - Etils:
      - Auto Tx: generated-etils-auto_tx.md
      - Configs: generated-etils-configs.md
      - Easystate: generated-etils-easystate.md
      - Errors: generated-etils-errors.md
      - Etils: generated-etils-etils.md
    - Eval:
      - Lm Eval: generated-eval-lm_eval.md
    - Modules:
      - Arctic:
        - Arctic Configuration: generated-modules-arctic-arctic_configuration.md
        - Modelling Arctic Flax: generated-modules-arctic-modelling_arctic_flax.md
      - Attention Module: generated-modules-attention_module.md
      - Attentions:
        - Blockwise Attn: generated-modules-_attentions-blockwise_attn.md
        - Flash: generated-modules-_attentions-flash.md
        - Ring: generated-modules-_attentions-ring.md
        - Vanilla: generated-modules-_attentions-vanilla.md
      - Auto Easydel Model: generated-modules-auto_easydel_model.md
      - Cohere:
        - Cohere Configuration: generated-modules-cohere-cohere_configuration.md
        - Modelling Cohere Flax: generated-modules-cohere-modelling_cohere_flax.md
      - Dbrx:
        - Dbrx Configuration: generated-modules-dbrx-dbrx_configuration.md
        - Modelling Dbrx Flax: generated-modules-dbrx-modelling_dbrx_flax.md
      - Deepseek V2:
        - Deepseek Configuration: generated-modules-deepseek_v2-deepseek_configuration.md
        - Modeling Deepseek Flax: generated-modules-deepseek_v2-modeling_deepseek_flax.md
      - Easydel Modelling Utils: generated-modules-easydel_modelling_utils.md
      - Falcon:
        - Falcon Configuration: generated-modules-falcon-falcon_configuration.md
        - Modelling Falcon Flax: generated-modules-falcon-modelling_falcon_flax.md
      - Flax Modelling Utils: generated-modules-flax_modelling_utils.md
      - Gemma:
        - Gemma Configuration: generated-modules-gemma-gemma_configuration.md
        - Modelling Gemma Flax: generated-modules-gemma-modelling_gemma_flax.md
      - Gpt J:
        - Gpt J Configuration: generated-modules-gpt_j-gpt_j_configuration.md
        - Modelling Gpt J Flax: generated-modules-gpt_j-modelling_gpt_j_flax.md
      - Gpt Neo X:
        - Gpt Neo X Configuration: generated-modules-gpt_neo_x-gpt_neo_x_configuration.md
        - Modelling Gpt Neo X Flax: generated-modules-gpt_neo_x-modelling_gpt_neo_x_flax.md
      - Gpt2:
        - Gpt2 Configuration: generated-modules-gpt2-gpt2_configuration.md
        - Modelling Gpt2 Flax: generated-modules-gpt2-modelling_gpt2_flax.md
      - Grok 1:
        - Grok 1 Configuration: generated-modules-grok_1-grok_1_configuration.md
        - Modelling Grok 1 Flax: generated-modules-grok_1-modelling_grok_1_flax.md
      - Jetmoe:
        - Jetmoe Configuration: generated-modules-jetmoe-jetmoe_configuration.md
        - Modelling Jetmoe Flax: generated-modules-jetmoe-modelling_jetmoe_flax.md
      - Llama:
        - Llama Configuration: generated-modules-llama-llama_configuration.md
        - Modelling Llama Flax: generated-modules-llama-modelling_llama_flax.md
        - Modelling Vision Llama Flax: generated-modules-llama-modelling_vision_llama_flax.md
        - Vision Llama Configuration: generated-modules-llama-vision_llama_configuration.md
      - Lucid Transformer:
        - Lt Configuration: generated-modules-lucid_transformer-lt_configuration.md
        - Modelling Lt Flax: generated-modules-lucid_transformer-modelling_lt_flax.md
      - Mamba:
        - Mamba Configuration: generated-modules-mamba-mamba_configuration.md
        - Modelling Mamba Flax: generated-modules-mamba-modelling_mamba_flax.md
      - Mistral:
        - Mistral Configuration: generated-modules-mistral-mistral_configuration.md
        - Modelling Mistral Flax: generated-modules-mistral-modelling_mistral_flax.md
        - Modelling Vision Mistral Flax: generated-modules-mistral-modelling_vision_mistral_flax.md
        - Vision Mistral Configuration: generated-modules-mistral-vision_mistral_configuration.md
      - Mixtral:
        - Mixtral Configuration: generated-modules-mixtral-mixtral_configuration.md
        - Modelling Mixtral Flax: generated-modules-mixtral-modelling_mixtral_flax.md
      - Mosaic Mpt:
        - Modelling Mpt Flax: generated-modules-mosaic_mpt-modelling_mpt_flax.md
        - Mosaic Configuration: generated-modules-mosaic_mpt-mosaic_configuration.md
      - Olmo:
        - Modelling Olmo Flax: generated-modules-olmo-modelling_olmo_flax.md
        - Olmo Configuration: generated-modules-olmo-olmo_configuration.md
      - Openelm:
        - Modelling Openelm Flax: generated-modules-openelm-modelling_openelm_flax.md
        - Openelm Configuration: generated-modules-openelm-openelm_configuration.md
      - Opt:
        - Modelling Opt Flax: generated-modules-opt-modelling_opt_flax.md
        - Opt Configuration: generated-modules-opt-opt_configuration.md
      - Palm:
        - Modelling Palm Flax: generated-modules-palm-modelling_palm_flax.md
        - Palm Configuration: generated-modules-palm-palm_configuration.md
      - Phi:
        - Modelling Phi Flax: generated-modules-phi-modelling_phi_flax.md
        - Phi Configuration: generated-modules-phi-phi_configuration.md
      - Phi3:
        - Modelling Phi3 Flax: generated-modules-phi3-modelling_phi3_flax.md
        - Phi3 Configuration: generated-modules-phi3-phi3_configuration.md
      - Qwen1:
        - Modelling Qwen1 Flax: generated-modules-qwen1-modelling_qwen1_flax.md
        - Qwen1 Configuration: generated-modules-qwen1-qwen1_configuration.md
      - Qwen2:
        - Modelling Qwen Flax: generated-modules-qwen2-modelling_qwen_flax.md
        - Qwen Configuration: generated-modules-qwen2-qwen_configuration.md
      - Qwen2 Moe:
        - Configuration Qwen2 Moe: generated-modules-qwen2_moe-configuration_qwen2_moe.md
        - Modeling Qwen2 Moe Flax: generated-modules-qwen2_moe-modeling_qwen2_moe_flax.md
      - Roberta:
        - Modelling Roberta Flax: generated-modules-roberta-modelling_roberta_flax.md
        - Roberta Configuration: generated-modules-roberta-roberta_configuration.md
      - Rwkv:
        - Modelling Rwkv Flax: generated-modules-rwkv-modelling_rwkv_flax.md
        - Rwkv Configuration: generated-modules-rwkv-rwkv_configuration.md
      - Stablelm:
        - Modelling Stablelm Flax: generated-modules-stablelm-modelling_stablelm_flax.md
        - Stablelm Configuration: generated-modules-stablelm-stablelm_configuration.md
      - T5:
        - Modelling T5 Flax: generated-modules-t5-modelling_t5_flax.md
        - T5 Configuration: generated-modules-t5-t5_configuration.md
      - Whisper:
        - Modelling Whisper Flax: generated-modules-whisper-modelling_whisper_flax.md
        - Whisper Configuration: generated-modules-whisper-whisper_configuration.md
    - Partitioning:
      - Partitioner: generated-partitioning-partitioner.md
    - Reinforcement Learning:
      - Core: generated-reinforcement_learning-core.md
      - Models:
        - Modelling Casual Language Rl: generated-reinforcement_learning-models-modelling_casual_language_rl.md
      - Trainer:
        - Partitioner Config: generated-reinforcement_learning-trainer-partitioner_config.md
        - Ppo Config: generated-reinforcement_learning-trainer-ppo_config.md
        - Ppo Trainer: generated-reinforcement_learning-trainer-ppo_trainer.md
        - Training Configs: generated-reinforcement_learning-trainer-training_configs.md
        - Utils: generated-reinforcement_learning-trainer-utils.md
      - Utils:
        - Collectors: generated-reinforcement_learning-utils-collectors.md
    - Serve:
      - Gradio User Interface Base: generated-serve-gradio_user_interface_base.md
      - Jax Serve: generated-serve-jax_serve.md
      - Prompters:
        - Base Prompter: generated-serve-prompters-base_prompter.md
        - Cargo Prompter: generated-serve-prompters-cargo_prompter.md
        - Chatml Prompter: generated-serve-prompters-chatml_prompter.md
        - Gemma Prompter: generated-serve-prompters-gemma_prompter.md
        - Guanaco Prompter: generated-serve-prompters-guanaco_prompter.md
        - Llama2 Prompter: generated-serve-prompters-llama2_prompter.md
        - Openchat Prompter: generated-serve-prompters-openchat_prompter.md
        - Zephyr Prompter: generated-serve-prompters-zephyr_prompter.md
      - Serve Engine:
        - Client: generated-serve-serve_engine-client.md
        - Configuration: generated-serve-serve_engine-configuration.md
        - Serve: generated-serve-serve_engine-serve.md
      - Torch Serve: generated-serve-torch_serve.md
      - Utils: generated-serve-utils.md
    - Smi:
      - Smi: generated-smi-smi.md
    - Trainer:
      - Base Trainer: generated-trainer-base_trainer.md
      - Causal Language Model Trainer:
        - Causal Language Model Trainer: generated-trainer-causal_language_model_trainer-causal_language_model_trainer.md
        - Fwd Bwd Functions: generated-trainer-causal_language_model_trainer-fwd_bwd_functions.md
        - Modeling Output: generated-trainer-causal_language_model_trainer-modeling_output.md
      - Dpo:
        - Dpo Trainer: generated-trainer-dpo-dpo_trainer.md
        - Fwd Bwd Functions: generated-trainer-dpo-fwd_bwd_functions.md
        - Modelling Output: generated-trainer-dpo-modelling_output.md
        - Utils: generated-trainer-dpo-utils.md
      - Orpo:
        - Fwd Bwd Functions: generated-trainer-orpo-fwd_bwd_functions.md
        - Modelling Output: generated-trainer-orpo-modelling_output.md
        - Orpo Trainer: generated-trainer-orpo-orpo_trainer.md
        - Utils: generated-trainer-orpo-utils.md
      - Sft:
        - Stf Trainer: generated-trainer-sft-stf_trainer.md
        - Utils: generated-trainer-sft-utils.md
      - Training Configurations: generated-trainer-training_configurations.md
      - Utils: generated-trainer-utils.md
      - Vision Causal Language Model Trainer:
        - Fwd Bwd Functions: generated-trainer-vision_causal_language_model_trainer-fwd_bwd_functions.md
        - Modelling Output: generated-trainer-vision_causal_language_model_trainer-modelling_output.md
        - Vision Causal Language Model Trainer: generated-trainer-vision_causal_language_model_trainer-vision_causal_language_model_trainer.md
    - Transform:
      - Easydel Transform: generated-transform-easydel_transform.md
      - Falcon: generated-transform-falcon.md
      - Llama: generated-transform-llama.md
      - Mistral: generated-transform-mistral.md
      - Mpt: generated-transform-mpt.md
      - Utils: generated-transform-utils.md
    - Utils:
      - Checker: generated-utils-checker.md
      - Prompters: generated-utils-prompters.md
      - Tensor Utils: generated-utils-tensor_utils.md
      - Utils: generated-utils-utils.md
  - Available models: AvailableModels.md
  - Contributing: CONTRIBUTING.md
  - Easy Bits: Bits.md
  - Examples:
    - DataProcessing: DataProcessing.md
    - Easy Attention: AttentionModuleExample.md
    - EasyState: EasyStateExample.md
    - Falcon Models: Falcon.md
    - Fine Tuning Example: FineTuningExample.md
    - JAXServer: JAXServer.md
    - Llama Models: Llama.md
    - Llama2 Models: Llama2.md
    - LoRA and Transfer Learning: LoRA-TransferLearningExample.md
    - Mistral Models: Mistral.md
    - Model Parameter Quantization: Parameter-Quantization.md
    - MosaicMPT Models: MosaicMPT.md
    - PytorchServer: PyTorchServer.md
  - Home: index.md
  - Install: Install.md

plugins:
  - search
  - mkdocstrings

repo_url: https://github.com/erfanzar/EasyDeL
site_author: Erfan Zare Chavoshi
site_name: EasyDeL
copyright: Erfan Zare Chavoshi-easydel

theme:
  highlightjs: true
  hljs_languages:
    - yaml
    - python
  name: material