Problem with example in docs

[shortcipher3]

Testing out mlem I ran mlem --help and saw the examples:

Examples:
    $ mlem init
    $ mlem list https://github.com/iterative/example-mlem
    $ mlem clone models/logreg --project https://github.com/iterative/example-mlem --rev main logreg
    $ mlem link logreg latest
    $ mlem apply latest https://github.com/iterative/example-mlem/data/test_x -o pred
    $ mlem serve latest fastapi -c port=8001
    $ mlem build latest docker_dir -c target=build/ -c server.type=fastapi

Great, let's test out the second one:

$ mlem clone models/logreg --project https://github.com/iterative/example-mlem --rev main logreg
❌ Revision 'main' wasn't found in path=https://github.com/iterative/example-mlem, fs=None
Please report it here: <https://github.com/iterative/mlem/issues>

Maybe try a different example:

➜ mlem clone models/logreg --project https://github.com/iterative/example-mlem --rev main logreg
❌ Revision 'main' wasn't found in path=https://github.com/iterative/example-mlem, fs=None

Oh it looks like this url https://github.com/iterative/example-mlem is bad, maybe I should use the frozen repo?

$ mlem clone models/logreg --project https://github.com/iterative/example-mlem-frozen --rev main logreg
❌ Unexpected error: 403 Client Error: rate limit exceeded for url: https://api.github.com/repos/iterative/example-mlem-frozen/git/trees/main
Please report it here: <https://github.com/iterative/mlem/issues>

It would be great for quick testing purposes if the examples worked or if these are dummy urls to make it more clear that we need to provide urls for projects we set up. I'm also concerned about the rate limiting error, is that something I will run into if I start using this for my projects?

[aguschin]

@mike0sv, we discussed this already. Do you think we need to just remove this examples, or update them? Since we need to update docs already, it's not that convenient to update this in both places for such a huge project. But it's still useful. WDYT?

[aguschin]

I'm fine with both, but considering limited capacity we have I would prefer removing this and keeping docs only.

[mike0sv]

ok, can we add a link to documentation instead?

[aguschin]

Yes, sure. In mlem --help only? Or in each mlem cmd --help?

[mike0sv]

makes sense to do each

[aguschin]

closed by #408