Regarding description of code

[deepakraina99]

I request contributors to provide some description of the code in a readme file so that it would be easy to understand.

[rejuvyesh]

Mostly wrote this to support pytorch training of models in https://github.com/sisl/StructuredMechModels.jl which should have better documentation.

[mykelk]

It looks like the link to the docs is broken on that page.

[deepakraina99]

@rejuvyesh Are you planning to prepare a better doc file for this repository?

[rejuvyesh]

https://github.com/sisl/mechamodlearn might be of more interest to you because of python examples. What are you looking for in the documentation?

[deepakraina99]

@rejuvyesh I tried to understand the flow of code in this repository and found it a bit difficult to catch up. So I was looking for documentation to understand the flow of code. Thanks for sharing the link to another repository. I will have a look at it and get back to you.