fatalError ("Fatal error: failed to find the CoreML models.)

[alelordelo]

Thanks for sharing this @ynagatomo!

I keep getting this error, even after checking 10x the folder, making sure that is has target check, etc...
Any idea what could be the issue?

cheers from Stockholm!

[TKennyMat]

works with the commented out line:

guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: nil) else { fatalError("Fatal error: failed to find the CoreML models.")

it still gives the error of Failed to get the home directory when checking model path but atleast doesn't crash with a fatal error

[ynagatomo]

As TKennyMat said, below is correct.
guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: nil) else {
fatalError("Fatal error: failed to find the CoreML models.")
}
This locates the file path of models.
And you don't need to add the "Unet" model file because you added "UnetChunk1" and "UnetChunk2". Adding unnecessary model files makes the binary size large. Please remove the "Unet" model file. :)

[alelordelo]

thanks @ynagatomo @TKennyMat

I am trying for a whole day to get this working with all possible paths variations, but it keeps always crashing and not finding the models.

I you have any insights on what could be wrong I highly appreciate!

I

[alelordelo]

btw, I am building for MacOS with slightly adapted code for NSImage

import StableDiffusion
import SwiftUI

@MainActor
final class ImageGenerator: ObservableObject {
    struct GenerationParameter {
        var prompt: String
        var seed: Int
        var stepCount: Int
        var imageCount: Int
        var disableSafety: Bool
    }

    struct GeneratedImage: Identifiable {
        let id: UUID = UUID()
        let uiImage: NSImage
    }

    struct GeneratedImages {
        let prompt: String
        let imageCount: Int
        let stepCount: Int
        let seed: Int
        let disableSafety: Bool
        let images: [GeneratedImage]
    }

    enum GenerationState: Equatable {
        case idle
        case generating(progressStep: Int)
        static func == (lhs: Self, rhs: Self) -> Bool {
            switch (lhs, rhs) {
            case (.idle, idle): return true
            case (.generating(let step1), .generating(let step2)):
                if step1 == step2 { return true
                } else { return false }
            default:
                return false
            }
        }
    }

    @Published var generationState: GenerationState = .idle
    @Published var generatedImages: GeneratedImages?
    private let sdpipeline: StableDiffusionPipeline
    
    init() {
        guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: nil) else {
            
       // guard let path =  Bundle.main.path(forResource: "CoreMLModels", ofType: "mlmodelc", inDirectory: "CoreMLModels") else {
       // guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: "CoreMLModels")
       // guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: nil) else {
     //   guard let path =  Bundle.main.path(forResource: "CoreMLModels", ofType: "mlmodelc", inDirectory: "bundle.bundle") else {
            fatalError("Fatal error: failed to find the CoreML models.")
        }
        
        let resourceURL = URL(fileURLWithPath: path)
        // TODO: move the pipeline creation to background task because it's heavy
        if let pipeline = try? StableDiffusionPipeline(resourcesAt: resourceURL) {
            sdpipeline = pipeline
        } else {
            fatalError("Fatal error: failed to create the Stable-Diffusion-Pipeline.")
        }
    }

    func setState(_ state: GenerationState) { // for actor isolation
        generationState = state
    }

    func setGeneratedImages(_ images: GeneratedImages) { // for actor isolation
        generatedImages = images
    }

    func generateImages(_ parameter: GenerationParameter) {
        guard generationState == .idle else { return }
        Task.detached(priority: .high) {
            await self.setState(.generating(progressStep: 0))
            do {
                //  generateImages(prompt: String, imageCount: Int = 1, stepCount: Int = 50, seed: Int = 0,
                //  disableSafety: Bool = false,
                //  progressHandler: (StableDiffusionPipeline.Progress) -> Bool = { _ in true }) throws -> [CGImage?]
                // TODO: use the progressHandler
                let cgImages = try self.sdpipeline.generateImages(prompt: parameter.prompt,
                                                                  imageCount: parameter.imageCount,
                                                                  stepCount: parameter.stepCount,
                                                                  seed: parameter.seed,
                                                                  disableSafety: parameter.disableSafety)
                print("images were generated.")
                let uiImages = cgImages.compactMap { image in
                    if let cgImage = image {
                        let size = NSSize(width: cgImage.width, height: cgImage.height)
                        return NSImage(cgImage: cgImage, size: size)
                    } else {
                        return nil
                    }
                }
                await self.setGeneratedImages(GeneratedImages(prompt: parameter.prompt,
                                                              imageCount: parameter.imageCount,
                                                              stepCount: parameter.stepCount,
                                                              seed: parameter.seed,
                                                              disableSafety: parameter.disableSafety,
                                           images: uiImages.map { uiImage in GeneratedImage(uiImage: uiImage) }))
            } catch {
                print("failed.")
            }
            await self.setState(.idle)
        }
    }
}

[ynagatomo]

Hi. This code will get the CoreMLModels folder's path in the app bundle.
guard let path = Bundle.main.path(forResource: "CoreMLModels", ofType: nil, inDirectory: nil) else {
fatalError("Fatal error: failed to find the CoreML models.")
}
One possibility is that when you added the model files to your Xcode project, you didn't check "[v] Copy items if needed", so the actual files weren't copied. Please check the actual file's existence using Finder (not Xcode Project navigator).

This is a screenshot of the Finder. It shows there are model files in the CoreMLModels folder.

Thank you for the code using NSImage. If you build the app for only Mac, using Unet model instead of UnetChunk1/2 is better a little. :)

[alelordelo]

No worries @ynagatomo , glad you found useful! : )

Yeah, I revised all this options 100x, and still nothing... Are you on MacOS beta or normal?

[ynagatomo]

I use macOS 13.1 beta 4. Did you check the model file existence using Finder?

[ynagatomo]

That fatal error suggests that there is no CoreMLModels folder (not about model files). Could you please check it using Finder.

[alelordelo]

yup, the folder is there:

And all models have the target checked:

The only reason I can image is the Beta... I am on Ventura 13.0.1 (NOT Beta)....

[alelordelo]

This is the MacOS app link:
https://drive.google.com/drive/folders/1K5tXUrog1nZji3ibdfX3kWtGYSwj64YU?usp=sharing

If you want to test and give some feedback if it builds on your side I hugely appreciate!

[ynagatomo]

According to Apple's documentation, model deployment requires macOS 13.1 or newer. This may be the cause. Sorry.

[ynagatomo]

I'll fix the readme. I'm sorry for wasting your precious time.

[alelordelo]

hi @ynagatomo, not at all!

Big thanks for sharing the repo and helping me found the issue! : )

[ynagatomo]

I found that the CoreMLModels folder in your Xcode project has no Target Membership to CoreMLDiffuse. So I delete the CoreMLModels group in the Xcode project navigator and added the folder and model files again. Then the app worked. No fatal error occurred.
For just to make the test simple, I modified your project a little: NSImage -> UIImage, Target -> My Mac (Designed for iPad) But these are not related to the issue.
I hope you will make it. :)

[alelordelo]

thanks a lot @ynagatomo !

As you pointed, the reason was the Target on the Folder. To fix this, I added the folder as a reference (without it, you cannot set a target), and then to worked,

But as you also pointed, my models are somehow coorrey (maybe due to not using MACOS 13.1 beta).

Great, will end you an emai to get the modelsl! : )