Object Recognition with Deep Boltzmann Machines

From AIRWiki
Revision as of 15:10, 3 February 2010 by GiulioFontana (Talk | contribs)

Jump to: navigation, search

This page explains how the creation and modification of project pages is done. Look here for an explanation of the full lifecycle of a project within the AIRWiki.

HOWTO add a new project to the AIRWiki

Step 1: registering as AIRWiki user

To modify the wiki (including the creation of new pages), you must be one or AIRWiki's registered users. SMW_Project_Workflow#Student_Registration explains what you have to do.

Step 2: Creating a page for the project in the AIRWiki

Each project must have an associated page. If the project you are going to work on hasn't already one, you have to create it by following the procedure described in SMW_Project_Workflow#Project_Instantiation. It's a good idea to ask your Tutor for the name of the new page. Please note that the new page already includes an automatically-generated frame on the right upper corner, used to show the basic information about your project.

Step 3: Providing basic information about your project in the new page

By clicking the "edit with form" tab on the top of the page, you access a simplified editing form which lets you input the main facts about your project.

Please note that all the content of the AIRWiki must be written in English.

The new page you just created can be edited in two ways:

  • if you only want to edit the basic information, you can choose a simplified method by clicking the "edit with form" tab on the top of the page;
  • to have full access to the content of the page (including the basic information), just click on the "edit" tab and change the source code of the page. Don't know how? Take a look to the MediaWiki Help. Tip: don't change the Semantic Media Wiki code on top of the source code (the lines between Template:And) if you don't know what you are doing.

While editing the project's page, you can click the "Show preview" button at the bottom of the page to see what your modifications look like. If you don't like what you see, press the 'back' button of your browser now to exit from the editing page without saving, then repeat the page editing by clicking again on the 'edit' tab on the top of the page. When you are certain that all is ok, click the "Save page" button at the bottom of the page.

As your work on your project goes on, don't forget to keep your project's page up-to-date by editing it every time you have new material. To know how, see #HOWTO add information to a project page.

HOWTO add information to a project page

The AIRWiki is a tool to share information about the AIRLab and AIRLab's projects. AIRWiki is divided into two parts, called Layers: a public layer - readable by anyone through the internet - and a private layer - only readable by Registered users.

Registered users can modify both layers of AIRWiki.

For project pages, the public layer can be changed by clicking the 'edit' tab on the top of the page. Thus, to add or modify something you only have to click that tab and do it. By clicking the 'Save Page' button on the bottom of the page, your work will be immediately made public to everyone on the internet. If you want to check the result before saving (a very good habit), click the 'Show preview' button and take a look before hitting the 'Save page' button. If you are not sure that what you see is exactly what it should (including the parts of the page that you didn't modify - or thought you didn't :-) ), just press the 'back' button of your browser now to exit from the editing page without saving, then repeat the page editing.

The private layer of project pages can be edited in just the same way: the only difference is that you have to click the 'discussion' tab instead of the 'edit' one. In this way you access the editing form for the discussion page associated to your project; this page has the same name of the associated project page, preceded by "Talk:". It is the place where you can put all your work notes.

You are strongly encouraged to use your project's page to store ANY useful information about the project, as soon as it is available. If such information is already sufficiently well-proven and well-formatted to be put on the public layer, you should directly put it there; if it is not, you should put it into the private layer, then prepare it for publication and finally move it to the public layer as soon as possible. See #Public or private? to understand what you should put into the public layer and what you should, instead, put into the private layer.

Tip: if you are editing the private layer of a project "MyProject", on the top of the web page you are looking at there is the title "Editing Talk:MyProject". If the title is "Editing MyProject" (i.e. if Talk: is missing), you are editing the public layer. For additional information, see Layers.

Actually, there is one important difference between modifying the public layer and the private layer: if you publish something wrong in the public layer, you make your mistake public to all the world. And you have full responsibility for what you publish (see the General disclaimer, also accessible by clicking the "Disclaimer" link on the bottom of every AIRWiki page). Of course, we all make mistakes, and you should not be too worried by the possibility that you write something that doesn't make sense scientifically or technically: but there are types of mistakes which mean trouble, such as those which infringe someone else's copyright. See Registered users#Warnings.

Public or private?

The right thing to do is to treat your project's page as an online repository of everything related to the project. You are encouraged to do just that. By doing so you:

  • help anyone that is working or will work on your project or a similar one by recording all useful information;
  • can access your documentation through the internet, from any PC.

As soon as you have some new information about your project (results, images, data, links, decisions, roadmaps, what you have done today, descriptions of things gone well or of errors made, warnings, and pretty much everything), it's very important that you put it into the project's page. In this way you will create a trace of how the project is proceeding, what difficulties you had to overcome, and how that was accomplished. To know how to put information in, see #HOWTO add information to a project page.

The obvious problem is: what information must be put into the "public" layer of the project's page and what should instead put into the "private" layer? You should follow these guidelines:

  • Any text of the public layer of AIRWiki must be written in English;
  • Anything on the public layer of AIRWiki should be sufficiently "finished" and checked for errors. Of course errors occur, so you shouldn't be too worried about that, but remember that you are creating a public page on the internet. If something needs to be revised or checked, leave it in the private layer until it's ready.
  • You should, eventually, migrate most of the content of the private layer to the public layer. (Well, excluding the details regarding your work that cannot be of interest to anyone out of the AIRLab, such as how much you paid for this and that :-) ) So:
    • try to keep the contents of the private layer of your project's page well organized: in this way the migration will be easy;
    • it's a good idea if you directly write everything in English!
  • Try to include into the project's page everything you would have liked to find there (if you work on a project started by others) and everything you think that people working on it in the future will like to find.
  • It is especially useful if you include a project diary into the private part of your project's page: a short description of everything you do, why you did it, and what resulted from it. This will be invaluable for those that will have to take your work further!

A final note: for your teachers, the AIRWiki will be the main source of information about how your project is going, so they will look at its page (public and private parts) often and with attention :-)