Add get_model_status function (#1558)

[sifisKoen]

Resolve (#1558)

Add get_model_status issue.

Include the function plus the doc string with explanation of the function.

[Wauplin]

Hey @sifisKoen, thanks for the PR! I made some comments to your changes. Most of thanks are just to remain consistent with the existing codebase.

It would be nice to have some tests added as well. You can take inspiration from TestHeadersAndCookies and define a TestModelStatus class with tests for the different use cases (loadable model, too big model, unknown model, model as url) and check the expected values. Please let me know if you have some questions!

[Wauplin]

Would be nice to add a docstring here. This is important as it is used to generate our documentation pages. Here is an example of documented dataclass.

[sifisKoen]

Got you 👍 I have already a doc string in the function that I implemented get_model_status I will do it to dataclass too.

[sifisKoen]

I will make these 8 changes.

[sifisKoen]

Hey,

I did the changes, as we discussed. Also I wrote the tests but I will need some time so to finish them. I will push the test in the next days. Sorry for the delay tho.

[Wauplin]

Thanks for your work. I've added a few tiny comments but overall looks test.
Please let me know if you need some help for the tests!

[Wauplin]

Suggested change

	Identifier of the model for witch the status gonna be returned(retrieve). If model is not provided,
	the model associated with this instance of InferenceClient will be used. The
	identifier should not be a URL.
	Identifier of the model for witch the status gonna be checked. If model is not provided,
	the model associated with this instance of [`InferenceClient`] will be used. Only InferenceAPI service can be checked so the
	identifier cannot be a URL.

[sifisKoen]

Hello.

Thank you the you accepted my contribute. I will make the commits now, of your changes. 😄

I wrote some tests but I don't know if they are ok. Please let me know what I should to include and what I need to change.

class TestModelStatus(unittest.TestCase):

    # loadable model test case
    def test_loadable_model(self) -> None:
        client = InferenceClient()
        model_status = client.get_model_status("")
        self.assertEqual(model_status.loaded, False)
        self.assertEqual(model_status.state, "Loadable")
        self.assertEqual(model_status.compute_type, "gpu")
        self.assertEqual(model_status.framework, "text-generation-inference")
    
    # too big model test case
    def test_too_big_model(self) -> None:
        client = InferenceClient()
        model_status = client.get_model_status("")
        self.assertEqual(model_status.loaded, False)
        self.assertEqual(model_status.state, "TooBig")
        self.assertEqual(model_status.compute_type, "cpu")
        self.assertEqual(model_status.framework, "transformers")

    # loaded model test case
    def test_loaded_model(self) -> None:
        client = InferenceClient()
        model_status = client.get_model_status("")
        self.assertEqual(model_status.loaded, False)
        self.assertEqual(model_status.state, "Loaded")
        self.assertEqual(model_status.compute_type, "gpu")
        self.assertEqual(model_status.framework, "text-generation-inference")

    # unknown model test case
    def test_unknown_model(self) -> None:
        client = InferenceClient()
        with self.assertRaises(ValueError):
            client.get_model_status("unknown/model")

    # model as url test case    
    def test_model_as_url(self) -> None:
        client = InferenceClient()
        with self.assertRaises(NotImplementedError):
            client.get_model_status("https://unkown/model")

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[Wauplin]

Hey @sifisKoen, yes that would be the idea for the tests! In details:

• test_unknown_model and test_model_as_url are fine
• test_loaded_model could check "bigcode/starcoder" (always loaded)
• test_too_big_model could check "facebook/nllb-moe-54b" (always too big)
• I would remove test_loadable_model as it's not easy to have a good example + it's not so important

Also for each test, I would merge those two lines but that's purely cosmetic:

        client = InferenceClient()
        model_status = client.get_model_status("")
        # Merge into =>
        # model_status = InferenceClient().get_model_status("")

[sifisKoen]

@Wauplin hey dude I just upload the tests like we discussed 😄 . Please let me know if everything is or I need to change something. 🤓

[Wauplin]

Hey @sifisKoen, thanks for completing the PR! I tested it locally and it works well! 🎉
I hope you don't mind but I've made some changes locally and pushed them to your branch, especially to support the same feature in AsyncInferenceClient. PR looks good to merge now! Thanks again 🤗