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

Support data downloading and loading #44

Closed
GiggleLiu opened this issue Jul 11, 2023 · 1 comment
Closed

Support data downloading and loading #44

GiggleLiu opened this issue Jul 11, 2023 · 1 comment
Assignees

Comments

@GiggleLiu
Copy link
Member

GiggleLiu commented Jul 11, 2023

          > > 

This change should solve the error you posted.

If you want the readers to use our artifact, you indeed need to tell them to copy this file into their project dir and to include the command that ensures that the artifact gets downloaded (Pkg.ensure_artifact_installed("uai2014", "Artifacts.toml")).

Instead of Pkg.ensure_artifact_installed("uai2014", "Artifacts.toml"), can we build the function into our package so that in the documentation we can write:

julia> TensorInference.download_data("uai2014")

julia> TensorInference.load_data("uai2014", name, task)

We still have Artifacts as a dependency, but will not download data automaticall for users.
Because it is very anoying when a user was told to find a specific file in his filesystem to follow a documentation. Especially for windows users.

Originally posted by @GiggleLiu in #41 (comment)

@mroavi mroavi self-assigned this Jul 11, 2023
@mroavi
Copy link
Collaborator

mroavi commented Jul 17, 2023

Since we already have read_instance, read_instance_from_string, we could name this new function read_instance_from_artifact to keep the naming consistent. I was also thinking that perhaps we could always do the check (Pkg.ensure_artifact_installed(artifact_name, artifact_toml)) inside this function so that it becomes transparent to the user.

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