Quickstart Docs

[valon]

hey there, was going through the docs and noticed that there is an update required.

specifically referring to: Quickstart | Modular

in the code, there is a missing argument: settings

was going to try and submit a pr to update it, but couldn’t find anywhere that allowed that. so posting it here.

from docs:

actual:

cheers!

[Ehsan (Ehsan M. Kermani)]

Settings exists in the 25.3 Quickstart | Modular but was removed to simplify so the nightly doc the one you’re looking at doesn’t have it.

[valon]

Hey Ehsan, thanks for your response.

For my project I actually used the stable build of modular through the pip install command below (as per the docs):

pip install modular
–extra-index-url https://download.pytorch.org/whl/cpu
–extra-index-url https://modular.gateway.scarf.sh/simple/

After installing, I ran the offline-inference.py file and that’s when the required parameter error popped up.

For reference, here’s the docs I’m referring to: Offline inference | Modular

And here is the code example which needs to be updated: modular/examples/offline-inference/basic.py at main · modular/modular · GitHub

I noticed that someone else also reported the same problem when going through the quickstart.

Happy to submit the PR to fix the example in GitHub, but we’ll also need to update the docs to reflect the need for the settings argument.

[Ehsan (Ehsan M. Kermani)]

Just to be clear the 25.3 docs does have settings but the nightly docs doesn’t.

[valon]

I see now, didn’t notice the nightly toggle on the top right of the docs page. Looks like when I navigated to the docs it defaulted to the nightly version.

Thanks for clearing that up!

A couple pieces of feedback that are worth mentioning:

1. The nightly docs defaulted for me, even though when I navigated to the quickstart guide, I clicked on the “Stable” tab. I also checked my local storage and can see the “stable” property is set, but the page continues to show the nightly docs until I explicitly click on 25.3
   

   

2. More a stylistic point, the nightly icon is a crescent moon which is very similar to the dark mode icon. Having these next to each other could be confusing. Probably why I missed it. I have a big monitor so might just be a “me-thing” but when I see the top right of the page and don’t focus in on it, I just see the crescent moon which makes me thing it’s just the dark mode icon.
   

3. I believe the code example in the github repo also needs to be updated. Whether you’re on nightly or stable, when you use the hyperlink to navigate to the github repo, it still has the nightly code example. Probably a good idea to create two separate example directories to account for the deviations between nightly and stable and navigate to the correct one based on the doc type.

Happy to help contribute for any of these changs. Love what modular is doing and the overall mission of the company. Keep up the great work!

[Scott]

Thanks so much for this feedback @valon!

Regarding #1, this is definitely something we need to solve. I did anticipate this kind of mismatch in the API behavior when we added the Nightly/Stable tabs in the quickstart, but honestly thought the API wasn’t going to change right away.

As for #3, that’s an unknown bug! It should work the way you expect, so I should be able to fix that quickly. Thank you!

[Scott]

Actually, @valon , I can’t reproduce the #3 problem. Can you please clarify which hyperlink you’re using? (When I click “Get the code” from the stable version of the Offline inference guide, I see the correct code.)

[valon]

Hey Scott,

The hyperlink I’m clicking on is the “Offline inference exampe” hyperlink which leads to the same link for nightly and stable. The “Get the code” link you’re referring to does indeed link to the correct reference code for stable and nightly.