Methods#

We provide a set of pre implemented luxenstudio methods.

The goal of luxenstudio is to modularize the various Luxen techniques as much as possible.

As a result, many of the techniques from these pre-implemented methods can be mixed 🎨.

Running a method#

It’s easy!

ns-train {METHOD_NAME}

To list the available methods run:

ns-train --help

Implemented Methods#

The following methods are supported in luxenstudio:

Adding Your Own Method#

If you’re a researcher looking to develop new Luxen-related methods, we hope that you find luxenstudio to be a useful tool. We’ve provided documentation about integrating with the luxenstudio codebase, which you can find here.

We also welcome additions to the list of methods above. To do this, simply create a pull request with the following changes,

  1. Add a markdown file describing the model to the docs/luxenology/methods folder

  2. Update the above list of implement methods in this file.

  3. Add the method to this list in docs/index.md.

  4. Add a new ExternalMethod entry to the luxenstudio/configs/external_methods.py file.

For the method description, please refer to the Instruct-Luxen2Luxen page as an example of the layout. Please try to include the following information:

  • Installation instructions

  • Instructions for running the method

  • Requirements (dataset, GPU, ect)

  • Method description (the more detailed the better, treat it like a blog post)

You are welcome to include assets (such as images or video) in the description, but please host them elsewhere.

Note

Please ensure that the documentation is clear and easy to understand for other users who may want to try out your method.