search

SofaDefrost / SofaGym

Machine Learning framework for Sofa
69 stars 10 forks source link

Cleaning start #6

Closed hunoutl closed 1 year ago

hunoutl commented 1 year ago

Refactoring the repo. AVEC & STLIB lib are gone. They don't have there place here. to do -> add requirements sofagym folder contains the sofagym lib. We can find examples scene in env (was envs before but rename to env to imitate the gym lib). to do -> i think it's strange how it is done right now. To me it's should be a repo root. to do -> make corrections everywhere to be sync with sofa 22.06. Some calls are deprecated...

hunoutl commented 1 year ago

Are AVEC & STLIB used anywhere in the project? In an example? If yes, documentation should be updated to explain how to use AVEC and STLIB as an external dependency. Is it your plan when you say "to do -> add requirements"?

exactly

p-shg commented 1 year ago

Are AVEC & STLIB used anywhere in the project? In an example? If yes, documentation should be updated to explain how to use AVEC and STLIB as an external dependency. Is it your plan when you say "to do -> add requirements"?

exactly

STLIB was added to the project a long time ago when the master STLIB was not up to date with SofaPython3, it is probably not needed anymore. AVEC was used by @EtienneMenager for an experiment in the paper but I don't think we need to carry it here. Etienne what do you think?

EtienneMenager commented 1 year ago

Are AVEC & STLIB used anywhere in the project? In an example? If yes, documentation should be updated to explain how to use AVEC and STLIB as an external dependency. Is it your plan when you say "to do -> add requirements"?

exactly

STLIB was added to the project a long time ago when the master STLIB was not up to date with SofaPython3, it is probably not needed anymore. AVEC was used by @EtienneMenager for an experiment in the paper but I don't think we need to carry it here. Etienne what do you think?

Yes, AVEC was just to show that we could use any kind of RL algorithms, even the ones that are coming from the actual research. For the library it is not very important I think...

hunoutl commented 1 year ago

I started the readme update. For the examples folder, after reading gym's documentation and its way of register envs, I think it's better to keep the structure that I had already started to put in place. Namely sofagym.envs which contains the basic Sofa/Gym environments. to do -> a documentation or a template to add easily a new env for sofagym.