CXCSCMU GroupWiki

Organize your code

Create your own branch for development and regularly submit changes to your branch! Here are some development steps you may refer to:

For new features/experiments, it is highly recommended to create a new branch
After developing and thorough test, merge the new features to your branch
If you think these features can benefit everyone in the group, merge them into the main branch by pull request (peers should do code review and test)

Organize your results

Loss curve

If you do train the model, the loss curve is vital in terms of debugging, providing insights, and reproducing your results.

It is recommended to use wandb to show your loss curve:

   # you may be asked to fill in the API key
   wandb.init(project=wandb_project, name=wandb_run_name, config=hparams, dir=out_dir)

   """
   Every logging step
   """
   wandb.log({
          "step": train_step,
          "train/loss": train_loss,
 				 "val/loss": val_loss,
          "step time": (t1 - t0),
          "lr": lr,
         })

When you are training, you can keep track of the curve online and export the reports to share at the end of the training.

Evaluation numbers

Create the folder named by your name/project name under the Google Drive CXCSCMU_Group and use Google Sheets to illustrate the numbers.

CXCSCMU GroupWiki

Contents