Difference between revisions of "Week 2"

From m1p.org
Jump to: navigation, search
 
(79 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
* '''The goal of this week''' is comprehend the main goal of your project and write about it.  
+
{{#seo:
 +
|title=Course My first scientific paper: Week 2
 +
|titlemode=replace
 +
|keywords=My first scientific paper
 +
|description=Course My first scientific paper: The goal of this week is to comprehend the main goal of your project and write about it.  
 +
}}
  
−
== Select your project (Spring 2021) ==
+
''The goal of this week'' is to land our project and write your main message.  
−
To select your project:
 
−
# [http://bit.ly/m1p_2021 Look through the list of projects].
 
−
# Find information about the experts and consultants.
 
−
# Select your projects in [https://docs.google.com/spreadsheets/d/1g-wAjdth3yvGg9HesjBAld-c2KoIcc-AOhIk9SPUETs/edit?usp=sharing].
 
−
# Wait for confirmation from
 
−
# Put confirmed topics [http://bit.ly/m1p_2021 to the Group table on Machinelearning.ru]
 
  
 
== A: Abstract ==  
 
== A: Abstract ==  
−
Write a ''draft'' of your abstract. The abstract shall not exceed 600 characters. It may contain:
+
# Discuss with your consultant the project goals and understand the problem statement.
−
# wide-range field of the investigated problem,
+
# Write a ''draft'' of your abstract, [https://github.com/vadim-vic/pub/raw/main/m1p/m1p_lect2.pdf  see the examples]. The abstract shall not exceed 600 characters. It may contain:
−
# narrow problem to focus on,
+
## wide-range field of the investigated problem,
−
# features and conditions of the problem,
+
## narrow problem to focus on,
−
# the novelty (please not exaggerate),
+
## features and conditions of the problem,
−
# application to illustrate with (put the results here later).
+
## the novelty,
−
<!--* For joint projects it is important that each team-member writes its own text.-->
+
## application to illustrate with.
  
−
== I: Introduction ==  
+
== Land your project ==
−
The introductory part includes research goals and motivations. It reasons the research with fundamental and state-of-the-arts references. It delivers the main message of the work to the reader. This message shows novelty of this work in comparison to recent results.  
+
# Find in the organization [https://github.com/intsystems github.com/intsystems]
 +
## the existing repository of your project or
 +
## create it with the title '''Project-N''' using the project short title, [https://github.com/Intelligent-Systems-Phystech see previous examples].
 +
# Create the folder structure:
 +
#* docs,
 +
#* code,
 +
#* ''[data]'' if you have a ''small dataset'' to run demo,
 +
#* ''[figs]'' if you have ''illustrations'' in read.me.
 +
# Put the link to your repository in the group table [https://github.com/intsystems/m1p/tree/main-2025 Spring 2025].
 +
# Fill out the '''readme.md''' file in the GitHub project. Use [https://github.com/Intelligent-Systems-Phystech/2021-Project-74 this example] as a template.
  
−
Write Introduction. The expected size is one page. The expected plan is:
+
===Tips for your healthy repository===
−
# the research goal (and its motivations),
+
Clone the ''master'' and upload your contributions. See a short [https://github.com/vadim-vic/pub/raw/main/m1p/m1p_lect2_github.pdf guide to  GitHub].
−
# the object of research (introduce main termini),
+
* ''Update first'', Commit after (Pull first, Push after)
−
# the problem (what is the challenge),
+
* ''Your own work only'', no external archives
−
# methodology: literature review and state-of-the-art
+
* ''No big files'' (put link to external datasets)
−
# the project tasks,
+
* ''No temporary'' nor dummy files
−
# the  proposed solution, its novelty and advantages,
 
−
# the profs and cons of recent works,
 
−
# goal of the experiment, set up, data sets, workflow.
 
  
−
Also, to refine your Introduction:
+
Tell the difference between [https://stackoverflow.com/questions/5009600/difference-between-fork-and-branch-on-github ''branch'' and ''fork''].
−
# ''Important!'' Wikipedia is not the source of information, but it contains many useful sources.
+
 
−
# ''Note that!'' ArXiv is not a peer-review source of information. Look for the  copies of papers that are published in peer-review scientific journals. If after one or two years after its ArXiv version, the pare did not appear in a peer-review journal, be careful to use it: this paper might be non-verified since it was rejected by the other journals.
+
Read the [https://github.com/intsystems/.github/blob/main/profile/repository_structure_rtfm.md#repository-for-educational-project Manual] on how to create a repository for educational projects.
−
# Create the file ''Surname2018Title.bib'' for your project.
+
 
−
# Move from the file ''LinkReview'' useful bibliographic records in the BibTeX format.
+
If a large collective project continues, create a personal folder in the project repository. Title it Surname2018Title.
−
#* Check the correctness of the BibTeX database (styles of authors names, volumes of journals, page numbers).
 
−
#* Use [http://liinwww.ira.uka.de/bibliography/ bibliographic databases] to facilitate your work.
 
−
#* Use the default style ''\bibliographystyle{plain}'' before the bibliography section ''\bibliography{ProjectN}''.
 
  
 
== L: Literature ==  
 
== L: Literature ==  
Line 54: Line 56:
 
## their students and teams,
 
## their students and teams,
 
## those, who refer to their works.
 
## those, who refer to their works.
−
# Balance the list of the new and well-known works.
+
# Balance the list of new and well-known works.
−
# Keep up-to date the list of keywords to search with.
+
# Keep up-to-date the list of keywords to search.
−
# Continuously fill your LinkReview.
+
# Continuously fulfill your LinkReview.
−
# Plan Introduction (see the next todo list), namely collect:
+
# Plan Introduction. Collect
−
#* keywords as the basic termini; those who brigs good search results are useful,
+
#* keywords as the basic termini; those who bring good search results are useful,
 
#* what the paper devoted to,
 
#* what the paper devoted to,
 
#* the investigated problem,
 
#* the investigated problem,
Line 64: Line 66:
 
#* literature review,
 
#* literature review,
 
#* the authors' contribution.
 
#* the authors' contribution.
 +
# Add to LinkReview the references to data sources, code repositories, and libraries.
 +
 +
===Tips for the bibliography collection===
 +
# Read and collect various sources, but mind [[Step 1#Select this kind of papers|what you cite]].
 +
# ArXiv is not a peer-reviewed source of information. Look for publications of these papers in peer-reviewed scientific journals. Be careful if the ArXiv paper does not appear in a peer-reviewed journal after one or two years. This paper might be non-verified since the other journals rejected it.
 +
# Wikipedia is not a source of information but contains many useful references.
  
 
== B: Beginner's-talk ==
 
== B: Beginner's-talk ==
 
Short 45-second introductory talk. Plan of the talk:
 
Short 45-second introductory talk. Plan of the talk:
−
# The project goal. What is the motivation, the goal to reach?  
+
# The project goal. What is the motivation and the goal to reach?  
 
# The main idea. What is the message?
 
# The main idea. What is the message?
 
# The expected result. What is your delivery, your impact, novelty?
 
# The expected result. What is your delivery, your impact, novelty?
−
There is no time to show a slide or draw a plot on the blackboard. It is recommended to rehearse the report. '''Week 3 starts with your talk'''.
+
There is no time to show a slide or draw a plot on the blackboard. ''Do rehearse'' your talk before the mirror. Week 3 starts with your talk.
 +
 
 +
==Homework==
 +
# [[Week_2#Land_your_project|Land your project]].
 +
# Put the links to your project [https://github.com/intsystems/m1p/tree/main-2025 in the group table].
 +
# Prepare the letter '''A''':
 +
## discuss it with your consultant after reading (Step 1)
 +
## [[Step 1#Abstract|Abstract]]
 +
## [[Step 1#Highlights|Highlights]]
 +
## [[Step 1#Keywords|Keywords]]
 +
## [[Step 1#Select this kind of papers|Papers]]
 +
# Put it to your .tex.
 +
# Write the '''read.me''' file.
 +
# Read the literature. Put the references to your .bib file, and prepare the letter '''L'''.
 +
# Prepare the letter '''B''', the beginner's talk.
 +
 
 +
==References==
 +
# [https://en.wikipedia.org/wiki/List_of_academic_databases_and_search_engines List of academic databases and search engines]
 +
# [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper], by S. Keshav, 2016
 +
# [http://www.machinelearning.ru/wiki/images/1/1a/CommResrarchProtocol.pdf Выполнение исследовательских проектов] в коммерческой организации: методические рекомендации
 +
 
 +
===Write or translate?===
 +
The rule is simple: write in the language you think in.
 +
# Read with pleasure (Ru) [http://www.math.nsc.ru/LBRT/g2/english/ssk/r-e.pdf Советы эпизодическому переводчику]. С.С. Кутателадзе
 +
#[http://www.ega-math.narod.ru/Quant/ABS.htm Как написать математическую статью по-английски]. А.Б. Сосинский
 +
# [https://orfogrammka.ru/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA_%D0%B8%D0%B7%D0%B4%D0%B0%D1%82%D0%B5%D0%BB%D1%8F_%D0%B8_%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B0_%D0%BC%D0%B8%D0%BB%D1%8C%D1%87%D0%B8%D0%BD_%D1%87%D0%B5%D0%BB%D1%8C%D1%86%D0%BE%D0%B2%D0%B0/ Справочник издателя и автора]. А.Э. Мильчин, Л.К. Чельцова
  
 +
==Teacher's plan==
 +
# Fill out the [https://forms.gle/1qNwWp7DxAM4W6Sg7 questionnaire] (discuss the previous and this one)
 +
# Discuss the umbrella terminology
 +
# Discuss the homework
 +
#* Show the examples of the abstracts
 +
# Discuss the homework section
  
−
== Resources ==
+
<!-- ==Archive==
−
* [https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf How to Read a Paper, 2016, S. Keshav]
+
[https://github.com/intsystems/ProjectTemplate old project template is excessive>
−
* Bibliographic databases
+
-->
−
** [http://liinwww.ira.uka.de/bibliography/ The Collection of Computer Science Bibliographies]
+
==Steps to check the homework==
−
** [http://en.wikipedia.org/wiki/List_of_academic_databases_and_search_engines List of academic databases and search engines in Wikipedia]
+
# After the [[Course schedule#Consultations|deadline]]
−
** Refer to [http://ru.wikipedia.org/wiki/BibTeX BibTeX in Wikipedia]
+
# Run through the [https://github.com/intsystems/m1p/tree/main-2025?tab=readme-ov-file#results table records]
−
** [http://svn.code.sf.net/p/mlalgorithms/code/Examples/ArticleReviews/%20r0_ESWA_review_report.pdf An introduction] updated after a peer-review.
+
# Check if the links open in one click to the material
−
* Examples of rewiev-and-planning drafts LinkReview [https://docs.google.com/document/d/1fx7fVlmnwdTesElt-lbaHvoGEjJC5t_9e-X0ZpUzEcQ/edit?usp=sharing раз], [https://docs.google.com/document/d/1XNhnwvooJwjj5UL6lkTio0bpvRKIj2NPVNCdHDRLOLc/edit?usp=sharing два].
+
#* for the papers there must be .pdf, .tex, and .bib files
−
* [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/MotivationExamples.pdf Examples of project goals and motivations].
+
# Check the ''Title, Abstract, and Keywords'' in the paper pdf and put the Letter '''A'''
−
* [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/AbstractExamples.pdf Примеры аннотаций].
+
#* or A0 if not
−
* [https://github.com/Strijov/Strijov2018-1AutomationOfResearch/raw/master/MotivationExamples.pdf Примеры целеполаганий].
+
# Check the file ''LinkReview'' and put the letter '''L'''
−
* [[Media:CommResrarchProtocol.pdf|Методические рекомендации выполнения исследовательских проектов в коммерческой фирме]].
+
#* put L0 if not
−
* [https://cs10.pikabu.ru/post_img/big/2018/07/10/4/1531199339121474094.jpg Демотиватор про Карлсона]
+
# Check the quality of the Abstract and usefulness of LinkReview and if needed
 +
#* put comments in the [https://docs.google.com/spreadsheets/d/1k6YFGp_0zwUNeQQZxoNbYdPjIn7iISkXqMRn1Ktc4t8/edit?usp=sharing Table]

Latest revision as of 14:02, 5 March 2025

The goal of this week is to land our project and write your main message.

A: Abstract

  1. Discuss with your consultant the project goals and understand the problem statement.
  2. Write a draft of your abstract, see the examples. The abstract shall not exceed 600 characters. It may contain:
    1. wide-range field of the investigated problem,
    2. narrow problem to focus on,
    3. features and conditions of the problem,
    4. the novelty,
    5. application to illustrate with.

Land your project

  1. Find in the organization github.com/intsystems
    1. the existing repository of your project or
    2. create it with the title Project-N using the project short title, see previous examples.
  2. Create the folder structure:
    • docs,
    • code,
    • [data] if you have a small dataset to run demo,
    • [figs] if you have illustrations in read.me.
  3. Put the link to your repository in the group table Spring 2025.
  4. Fill out the readme.md file in the GitHub project. Use this example as a template.

Tips for your healthy repository

Clone the master and upload your contributions. See a short guide to GitHub.

  • Update first, Commit after (Pull first, Push after)
  • Your own work only, no external archives
  • No big files (put link to external datasets)
  • No temporary nor dummy files

Tell the difference between branch and fork.

Read the Manual on how to create a repository for educational projects.

If a large collective project continues, create a personal folder in the project repository. Title it Surname2018Title.

L: Literature

We use the LinkReview draft format to share our evanescent ephemeral ideas and impressions we have during the literature reading.

  1. Collect the list of references including:
    1. state-of-the-art reviews, tutorials,
    2. fundamental solutions to the problem,
    3. the basic algorithm to solve your problem,
    4. alternative algorithms,
    5. [changes in the research directions],
    6. data sets and experiments,
    7. the papers that use these data sets
    8. applications of the results,
    9. names of researchers, who solve this problem,
    10. their students and teams,
    11. those, who refer to their works.
  2. Balance the list of new and well-known works.
  3. Keep up-to-date the list of keywords to search.
  4. Continuously fulfill your LinkReview.
  5. Plan Introduction. Collect
    • keywords as the basic termini; those who bring good search results are useful,
    • what the paper devoted to,
    • the investigated problem,
    • the central idea,
    • literature review,
    • the authors' contribution.
  6. Add to LinkReview the references to data sources, code repositories, and libraries.

Tips for the bibliography collection

  1. Read and collect various sources, but mind what you cite.
  2. ArXiv is not a peer-reviewed source of information. Look for publications of these papers in peer-reviewed scientific journals. Be careful if the ArXiv paper does not appear in a peer-reviewed journal after one or two years. This paper might be non-verified since the other journals rejected it.
  3. Wikipedia is not a source of information but contains many useful references.

B: Beginner's-talk

Short 45-second introductory talk. Plan of the talk:

  1. The project goal. What is the motivation and the goal to reach?
  2. The main idea. What is the message?
  3. The expected result. What is your delivery, your impact, novelty?

There is no time to show a slide or draw a plot on the blackboard. Do rehearse your talk before the mirror. Week 3 starts with your talk.

Homework

  1. Land your project.
  2. Put the links to your project in the group table.
  3. Prepare the letter A:
    1. discuss it with your consultant after reading (Step 1)
    2. Abstract
    3. Highlights
    4. Keywords
    5. Papers
  4. Put it to your .tex.
  5. Write the read.me file.
  6. Read the literature. Put the references to your .bib file, and prepare the letter L.
  7. Prepare the letter B, the beginner's talk.

References

  1. List of academic databases and search engines
  2. How to Read a Paper, by S. Keshav, 2016
  3. Выполнение исследовательских проектов в коммерческой организации: методические рекомендации

Write or translate?

The rule is simple: write in the language you think in.

  1. Read with pleasure (Ru) Советы эпизодическому переводчику. С.С. Кутателадзе
  2. Как написать математическую статью по-английски. А.Б. Сосинский
  3. Справочник издателя и автора. А.Э. Мильчин, Л.К. Чельцова

Teacher's plan

  1. Fill out the questionnaire (discuss the previous and this one)
  2. Discuss the umbrella terminology
  3. Discuss the homework
    • Show the examples of the abstracts
  4. Discuss the homework section

Steps to check the homework

  1. After the deadline
  2. Run through the table records
  3. Check if the links open in one click to the material
    • for the papers there must be .pdf, .tex, and .bib files
  4. Check the Title, Abstract, and Keywords in the paper pdf and put the Letter A
    • or A0 if not
  5. Check the file LinkReview and put the letter L
    • put L0 if not
  6. Check the quality of the Abstract and usefulness of LinkReview and if needed
    • put comments in the Table
Retrieved from ‘https://m1p.org/index.php?title=Week_2&oldid=2133’