AI Engineer Code Challenge

Contents:

  • Installation Guide
    • Prerequisites
    • System Requirements
    • Installation Steps
    • Installation Options
      • Standard Installation
      • Minimal Installation
      • GPU Support
      • Development Installation
    • Configuration
    • Troubleshooting
      • Common Installation Issues
    • Verification
    • Next Steps
  • API Reference
    • Core Modules
      • ChunkMetadata
        • ChunkMetadata.file_name
        • ChunkMetadata.page_number
        • ChunkMetadata.chunk_index
        • ChunkMetadata.chunk_start
        • ChunkMetadata.chunk_end
        • ChunkMetadata.chunk_size
        • ChunkMetadata.text_length
        • ChunkMetadata.__init__()
      • DocumentChunk
        • DocumentChunk.text
        • DocumentChunk.metadata
        • DocumentChunk.__init__()
      • PDFProcessor
        • PDFProcessor.__init__()
        • PDFProcessor.extract_text()
      • TextCleaner
        • TextCleaner.__init__()
        • TextCleaner.clean_text()
      • TextChunker
        • TextChunker.__init__()
        • TextChunker.chunk_text()
      • DocumentIngester
        • DocumentIngester.__init__()
        • DocumentIngester.ingest_documents()
        • DocumentIngester.save_chunks()
      • ingest_documents()
      • EmbeddingConfig
        • EmbeddingConfig.model_name
        • EmbeddingConfig.normalize_embeddings
        • EmbeddingConfig.device
        • EmbeddingConfig.similarity_threshold
        • EmbeddingConfig.top_k
        • EmbeddingConfig.__init__()
      • EmbeddingModel
        • EmbeddingModel.__init__()
        • EmbeddingModel.generate_embeddings()
        • EmbeddingModel.generate_single_embedding()
      • FAISSIndex
        • FAISSIndex.__init__()
        • FAISSIndex.add_embeddings()
        • FAISSIndex.search()
        • FAISSIndex.get_chunk_by_index()
        • FAISSIndex.get_total_embeddings()
        • FAISSIndex.save_index()
        • FAISSIndex.load_index()
      • EmbeddingPipeline
        • EmbeddingPipeline.__init__()
        • EmbeddingPipeline.create_embeddings_from_chunks()
        • EmbeddingPipeline.save_index()
        • EmbeddingPipeline.load_index()
        • EmbeddingPipeline.search_similar_chunks()
        • EmbeddingPipeline.get_index_stats()
      • create_embeddings_from_chunks_file()
      • load_embedding_pipeline()
      • QueryResult
        • QueryResult.query
        • QueryResult.chunks
        • QueryResult.similarities
        • QueryResult.total_chunks_searched
        • QueryResult.search_time_ms
        • QueryResult.__init__()
      • QueryEngine
        • QueryEngine.__init__()
        • QueryEngine.search()
        • QueryEngine.get_index_stats()
        • QueryEngine.validate_index()
      • QueryProcessor
        • QueryProcessor.__init__()
        • QueryProcessor.process_query()
        • QueryProcessor.format_results()
        • QueryProcessor.get_relevant_context()
      • process_query()
      • format_query_output()
      • LLMConfig
        • LLMConfig.backend
        • LLMConfig.model_path
        • LLMConfig.temperature
        • LLMConfig.max_tokens
        • LLMConfig.top_p
        • LLMConfig.repeat_penalty
        • LLMConfig.context_window
        • LLMConfig.__init__()
      • LLMResponse
        • LLMResponse.answer
        • LLMResponse.prompt_tokens
        • LLMResponse.response_tokens
        • LLMResponse.generation_time_ms
        • LLMResponse.model_used
        • LLMResponse.__init__()
      • BaseLLM
        • BaseLLM.__init__()
        • BaseLLM.generate()
      • TransformersLLM
        • TransformersLLM.generate()
      • LlamaCppLLM
        • LlamaCppLLM.generate()
      • OpenAILLM
        • OpenAILLM.generate()
      • LLMInterface
        • LLMInterface.__init__()
        • LLMInterface.format_prompt()
        • LLMInterface.generate_answer()
        • LLMInterface.get_model_info()
      • create_llm_interface()
      • generate_answer_from_query()
      • format_llm_response()
      • setup_logging()
      • get_logger()
      • log_memory_usage()
      • log_performance()
      • batch_process()
      • optimize_memory()
      • create_cache_directory()
      • get_system_info()
      • log_system_info()
      • ProgressTracker
        • ProgressTracker.__init__()
        • ProgressTracker.update()
        • ProgressTracker.finish()
    • Data Structures
      • ChunkMetadata
        • ChunkMetadata.file_name
        • ChunkMetadata.page_number
        • ChunkMetadata.chunk_index
        • ChunkMetadata.chunk_start
        • ChunkMetadata.chunk_end
        • ChunkMetadata.chunk_size
        • ChunkMetadata.text_length
        • ChunkMetadata.__init__()
      • DocumentChunk
        • DocumentChunk.text
        • DocumentChunk.metadata
        • DocumentChunk.__init__()
      • PDFProcessor
        • PDFProcessor.__init__()
        • PDFProcessor.extract_text()
      • TextCleaner
        • TextCleaner.__init__()
        • TextCleaner.clean_text()
      • TextChunker
        • TextChunker.__init__()
        • TextChunker.chunk_text()
      • DocumentIngester
        • DocumentIngester.__init__()
        • DocumentIngester.ingest_documents()
        • DocumentIngester.save_chunks()
      • ingest_documents()
      • EmbeddingConfig
        • EmbeddingConfig.model_name
        • EmbeddingConfig.normalize_embeddings
        • EmbeddingConfig.device
        • EmbeddingConfig.similarity_threshold
        • EmbeddingConfig.top_k
        • EmbeddingConfig.__init__()
      • EmbeddingModel
        • EmbeddingModel.__init__()
        • EmbeddingModel.generate_embeddings()
        • EmbeddingModel.generate_single_embedding()
      • FAISSIndex
        • FAISSIndex.__init__()
        • FAISSIndex.add_embeddings()
        • FAISSIndex.search()
        • FAISSIndex.get_chunk_by_index()
        • FAISSIndex.get_total_embeddings()
        • FAISSIndex.save_index()
        • FAISSIndex.load_index()
      • EmbeddingPipeline
        • EmbeddingPipeline.__init__()
        • EmbeddingPipeline.create_embeddings_from_chunks()
        • EmbeddingPipeline.save_index()
        • EmbeddingPipeline.load_index()
        • EmbeddingPipeline.search_similar_chunks()
        • EmbeddingPipeline.get_index_stats()
      • create_embeddings_from_chunks_file()
      • load_embedding_pipeline()
      • QueryResult
        • QueryResult.query
        • QueryResult.chunks
        • QueryResult.similarities
        • QueryResult.total_chunks_searched
        • QueryResult.search_time_ms
        • QueryResult.__init__()
      • QueryEngine
        • QueryEngine.__init__()
        • QueryEngine.search()
        • QueryEngine.get_index_stats()
        • QueryEngine.validate_index()
      • QueryProcessor
        • QueryProcessor.__init__()
        • QueryProcessor.process_query()
        • QueryProcessor.format_results()
        • QueryProcessor.get_relevant_context()
      • process_query()
      • format_query_output()
      • LLMConfig
        • LLMConfig.backend
        • LLMConfig.model_path
        • LLMConfig.temperature
        • LLMConfig.max_tokens
        • LLMConfig.top_p
        • LLMConfig.repeat_penalty
        • LLMConfig.context_window
        • LLMConfig.__init__()
      • LLMResponse
        • LLMResponse.answer
        • LLMResponse.prompt_tokens
        • LLMResponse.response_tokens
        • LLMResponse.generation_time_ms
        • LLMResponse.model_used
        • LLMResponse.__init__()
      • BaseLLM
        • BaseLLM.__init__()
        • BaseLLM.generate()
      • TransformersLLM
        • TransformersLLM.generate()
      • LlamaCppLLM
        • LlamaCppLLM.generate()
      • OpenAILLM
        • OpenAILLM.generate()
      • LLMInterface
        • LLMInterface.__init__()
        • LLMInterface.format_prompt()
        • LLMInterface.generate_answer()
        • LLMInterface.get_model_info()
      • create_llm_interface()
      • generate_answer_from_query()
      • format_llm_response()
    • Configuration
    • Command Line Interface
    • Examples
      • Basic Usage
      • Advanced Usage
    • Error Handling
    • Performance Optimization
    • Monitoring and Logging
    • Testing
AI Engineer Code Challenge
  • Search

© Copyright 2024, Solayman.

Built with Sphinx using a theme provided by Read the Docs.