Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

the installation guide for SwiftPM #71

Open
mzbac opened this issue Mar 16, 2024 · 3 comments
Open

the installation guide for SwiftPM #71

mzbac opened this issue Mar 16, 2024 · 3 comments

Comments

@mzbac
Copy link
Contributor

mzbac commented Mar 16, 2024

First of all, thank you for creating this awesome library for the community. I was just wondering if it would be possible to add an installation guide so that beginners like me could learn how to install it using SwiftPM. It took me a bit of time to figure out how to install it via SwiftPM.

Something as simple as:

SwiftPM

To use swift-transformers with SwiftPM, you can add this to your Package.swift:

dependencies: [
    .package(url: "https://github.com/huggingface/swift-transformers", from: "0.1.5")
]

and add the libraries as dependencies:

dependencies: [
    .product(name: "Transformers", package: swift-transformers"),
]
@pcuenca
Copy link
Member

pcuenca commented Mar 17, 2024

That's a very good idea, @mzbac! Would you like to open a PR for it? I'd maybe also cover how to use from a Xcode project, not just inside another package. What do you think?

@mzbac
Copy link
Contributor Author

mzbac commented Mar 18, 2024

Yeah, I would love to create a PR, but I am quite new to Swift and Xcode. Do you have any suggestions on how to cover the usage for an Xcode project?

@pcuenca
Copy link
Member

pcuenca commented Mar 18, 2024

Why don't we start with the SwiftPM instructions then? You'd just need to update the README for that. For usage in an Xcode project, you can play with this project to see how it's done. I can help you with that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants