Add "Properties" for each model

[QuinnHe]

No description provided.

[MOQN]

@alanvww, would you be available to handle this task this week? If not, we could totally do this next week after the soft launch.

[alanvww]

@MOQN I can do this with the method descriptions. The content is pretty related, but it will be easier if someone can co-review the content with me. I will also create a PR for the method part ASAP so @ziyuan-linn Peter can check if anything is missing.

[MOQN]

Thank you! I could also review from next week!!

[alanvww]

Hi Quinn, can you check the BodyPose section in #93 to see if it is good? I added more descriptions and completed the list of methods based on the source code. My understanding is that the "properties" are the options when we load the model? It would be great if you could elaborate on this a bit more.

[QuinnHe]

Hi Quinn, can you check the BodyPose section in #93 to see if it is good? I added more descriptions and completed the list of methods based on the source code. My understanding is that the "properties" are the options when we load the model? It would be great if you could elaborate on this a bit more.

Hi @alanvww , my understanding is - "properties" is the attributes of the bodyPose class. See screenshots for reference.

And I will comment in #93 .

[ziyuan-linn]

Hi @MOQN @alanvww @QuinnHe thank you for adding the properties section to the models!

I just noticed this section when looking at the website today. I am sorry that I didn't bring this up earlier, but to my understanding, the model properties are private and are not really meant to be accessed by the end users. If the users try to change the properties on a model, it might break.

I don't have a strong feeling about it, but perhaps it would be better if we could eventually move the properties information to a more technical section of our documentation?

[alanvww]

Hi @MOQN @alanvww @QuinnHe thank you for adding the properties section to the models!

I just noticed this section when looking at the website today. I am sorry that I didn't bring this up earlier, but to my understanding, the model properties are private and are not really meant to be accessed by the end users. If the users try to change the properties on a model, it might break.

I don't have a strong feeling about it, but perhaps it would be better if we could eventually move the properties information to a more technical section of our documentation?

Hey Peter, thanks for bringing this up. The current properties for each model are based on the model object created using the method call, like xxx = ml5.xxx(). I totally agree with you; we should encourage learners and developers to use the option instead of tweaking the properties. If we all agree to remove it, let’s do it!

One more thing I noticed while I’m slowly reviewing each model (sorry for the delay…) is that, for BodyPix in BodySegmentation, it’s now returning a BodyPix palette in the model object property:

Not sure about what the plan is for this palette yet, but to address your point, maybe something to try is wrap this data into a public method like how we handle getSkeleton in BodyPose?

[MOQN]

@ziyuan-linn thank you for addressing this important issue!

Hey Peter, thanks for bringing this up. The current properties for each model are based on the model object created using the method call, like xxx = ml5.xxx(). I totally agree with you; we should encourage learners and developers to use the option instead of tweaking the properties. If we all agree to remove it, let’s do it!

I agree with @alanvww. I believe it would be better to remove the private properties from the reference pages.

[shiffman]

Agreed too!!

[ziyuan-linn]

@alanvww Here is the PR that introduced the palette with a discussion. ml5js/ml5-next-gen#139. Those are meant to be public properties.

We could either wrap this data in a public method or document those public properties depending on how everyone feels.

Either way, I believe this is the only instance of public properties and all other properties are supposed to be private. I will also make sure to mark the properties as private when updating the comments.

Side note: Alan thank you so much for reviewing the models! Which specific models are you currently working on? Just want to check in to make sure we don't end up working on the same thing :)

[alanvww]

@ziyuan-linn Got it! Looks like we all agree on removing the private properties and I will update the docs soon.

For the palette, I think I could try to implement the getPartsId() we were talking about? This is something new to me, but I will certainly ask more of you to review.

As for reviewing, my focus right now is on getting the source code in line with the docs. Meanwhile, also cleaning up the code when I can. So it might be very slow. Three models that are in progress are BodyPose, BodySegmentation (these with your latest updates) and HandPose.