diff --git a/byaldi/RAGModel.py b/byaldi/RAGModel.py index 65dcf4c..b72b8f2 100644 --- a/byaldi/RAGModel.py +++ b/byaldi/RAGModel.py @@ -180,24 +180,24 @@ def as_langchain_retriever(self, **kwargs: Any): return ByaldiLangChainRetriever(model=self, kwargs=kwargs) def save_pretrained(self, directory_path: str) -> None: - """ - Save the model and processor to a specified directory. + """ + Save the model and processor to a specified directory. - Parameters: - directory_path (str): The path to the directory where the model and processor should be saved. + Parameters: + directory_path (str): The path to the directory where the model and processor should be saved. - Returns: - None + Returns: + None - This function saves both the model and processor components of the current instance - to the specified directory, allowing the model to be reloaded later from this checkpoint. - However for complete local setup follow this - https://github.com/illuin-tech/colpali/issues/129 + This function saves both the model and processor components of the current instance + to the specified directory, allowing the model to be reloaded later from this checkpoint. + However for complete local setup follow this - https://github.com/illuin-tech/colpali/issues/129 - Raises: - FileNotFoundError: If the specified directory does not exist. - PermissionError: If there are insufficient permissions to write to the directory. - Exception: For any other unexpected errors during the save process. - """ + Raises: + FileNotFoundError: If the specified directory does not exist. + PermissionError: If there are insufficient permissions to write to the directory. + Exception: For any other unexpected errors during the save process. + """ try: # Attempt to save the model and processor self.model.model.save_pretrained(directory_path)