Skip to content

Fix git push error for protected CLA branch #3619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jul 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"default": true,
"MD001": false,
"MD004": false,
"MD007": false,
"MD009": false,
"MD011": false,
"MD013": false,
Expand Down
76 changes: 38 additions & 38 deletions docs/ai/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,27 +82,27 @@ Then, we need to verify whether Python 3.5 is installed correctly, and upgrade p

- **Windows**

```cmd
C:\Users\test>python -V
Python 3.5.4
```cmd
C:\Users\test>python -V
Python 3.5.4

C:\Users\test>pip3.5 -V
pip 9.0.1 from c:\users\test\appdata\local\programs\python\python35\lib\site-packages (python 3.5)
C:\Users\test>pip3.5 -V
pip 9.0.1 from c:\users\test\appdata\local\programs\python\python35\lib\site-packages (python 3.5)

C:\Users\test>python -m pip install -U pip
```
C:\Users\test>python -m pip install -U pip
```

- **macOS**

```bash
MyMac:~ test$ python3.5 -V
Python 3.5.4
```bash
MyMac:~ test$ python3.5 -V
Python 3.5.4

MyMac:~ test$ pip3.5 -V
pip 9.0.1 from /Library/Frameworks/Python.framework/Versions/3.5/lib/python3.5/site-packages (python 3.5)
MyMac:~ test$ pip3.5 -V
pip 9.0.1 from /Library/Frameworks/Python.framework/Versions/3.5/lib/python3.5/site-packages (python 3.5)

MyMac:~ test$ python3.5 -m pip install -U pip
```
MyMac:~ test$ python3.5 -m pip install -U pip
```

### Python on Visual Studio

Expand Down Expand Up @@ -156,15 +156,15 @@ To install MXNet, run the following command in a terminal:

- With GPU

```bash
pip3.5 install mxnet-cu80==0.12.0
```
```bash
pip3.5 install mxnet-cu80==0.12.0
```

- Without GPU

```bash
pip3.5 install mxnet==0.12.0
```
```bash
pip3.5 install mxnet==0.12.0
```

### Keras

Expand Down Expand Up @@ -197,33 +197,33 @@ To install PyTorch, run the following command in a terminal:

- **Windows**

There's no official wheel package yet. You can download a third-party package from [Anaconda](https://anaconda.org/pytorch/repo?type=all) or [University of California](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pytorch).
There's no official wheel package yet. You can download a third-party package from [Anaconda](https://anaconda.org/pytorch/repo?type=all) or [University of California](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pytorch).

- Decompress it to your home directory, for example, *C:\Users\test\pytorch*.
- Add *C:\Users\test\pytorch\Lib\site-packages* to the %PYTHONPATH% environment variable.
- Decompress it to your home directory, for example, *C:\Users\test\pytorch*.
- Add *C:\Users\test\pytorch\Lib\site-packages* to the %PYTHONPATH% environment variable.

```bash
pip3 install http://download.pytorch.org/whl/cu80/torch-0.4.0-cp36-cp36m-win_amd64.whl
pip3 install torchvision
```
```bash
pip3 install http://download.pytorch.org/whl/cu80/torch-0.4.0-cp36-cp36m-win_amd64.whl
pip3 install torchvision
```

- **macOS**

```bash
pip3.5 install http://download.pytorch.org/whl/torch-0.2.0.post3-cp35-cp35m-macosx_10_7_x86_64.whl
```
```bash
pip3.5 install http://download.pytorch.org/whl/torch-0.2.0.post3-cp35-cp35m-macosx_10_7_x86_64.whl
```

> [!NOTE]
> macOS binaries don't support CUDA, install from source if CUDA is needed
> [!NOTE]
> macOS binaries don't support CUDA, install from source if CUDA is needed

- **Linux**

```bash
pip3.5 install http://download.pytorch.org/whl/cu80/torch-0.2.0.post3-cp35-cp35m-manylinux1_x86_64.whl
```
```bash
pip3.5 install http://download.pytorch.org/whl/cu80/torch-0.2.0.post3-cp35-cp35m-manylinux1_x86_64.whl
```

> [!NOTE]
> This single package supports both GPU and CPU.
> [!NOTE]
> This single package supports both GPU and CPU.

Finally, install torchvision on non-Windows:

Expand All @@ -248,4 +248,4 @@ To install Chainer, please run the following command in a terminal:

```bash
pip3.5 install chainer==3.0.0
```
```
6 changes: 3 additions & 3 deletions docs/code-quality/ca1507.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Rule CA1507 flags the use of a `string` literal as an argument to a method or co

- The constant value of the `string` literal matches either of the following:

- The name of a parameter of the method, lambda, or local function within which the method or constructor is being invoked.
- The name of a parameter of the method, lambda, or local function within which the method or constructor is being invoked.

- The name of a property of the type within which the method or constructor is being invoked.
- The name of a property of the type within which the method or constructor is being invoked.

- The argument corresponds to a `string`-typed parameter of the method or the constructor that's being invoked (that is, there is no conversion involved at the call site).

Expand Down Expand Up @@ -81,4 +81,4 @@ It's safe to suppress a violation of this rule if you're not concerned about the

## See also

- [Maintainability warnings](../code-quality/maintainability-warnings.md)
- [Maintainability warnings](../code-quality/maintainability-warnings.md)
14 changes: 7 additions & 7 deletions docs/code-quality/in-source-suppression-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,17 +61,17 @@ The properties of the attribute include:

- **Scope** - The target on which the warning is being suppressed. If the target is not specified, it is set to the target of the attribute. Supported [scopes](xref:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Scope) include the following:

- `module`
- `module`

- `resource`
- `resource`

- `type`
- `type`

- `member`
- `member`

- `namespace` - This scope suppresses warnings against the namespace itself. It does not suppress warnings against types within the namespace.
- `namespace` - This scope suppresses warnings against the namespace itself. It does not suppress warnings against types within the namespace.

- `namespaceanddescendants` - (New for Visual Studio 2019) This scope suppresses warnings in a namespace and all its descendant symbols. The `namespaceanddescendants` value is only valid for Roslyn analyzers, and is ignored by binary, FxCop-based static analysis.
- `namespaceanddescendants` - (New for Visual Studio 2019) This scope suppresses warnings in a namespace and all its descendant symbols. The `namespaceanddescendants` value is only valid for Roslyn analyzers, and is ignored by binary, FxCop-based static analysis.

- **Target** - An identifier that is used to specify the target on which the warning is being suppressed. It must contain a fully qualified item name.

Expand Down Expand Up @@ -165,4 +165,4 @@ The global suppression file maintains suppressions that are either global-level

- <xref:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.Scope>
- <xref:System.Diagnostics.CodeAnalysis>
- [Use Roslyn analyzers](../code-quality/use-roslyn-analyzers.md)
- [Use Roslyn analyzers](../code-quality/use-roslyn-analyzers.md)
32 changes: 16 additions & 16 deletions docs/code-quality/use-roslyn-analyzers.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,40 +104,40 @@ There are multiple ways to suppress rule violations:

- From the **Analyze** menu

Select **Analyze** > **Run Code Analysis and Suppress Active Issues** on the menu bar to suppress all current violations. This is sometimes referred to as "baselining".
Select **Analyze** > **Run Code Analysis and Suppress Active Issues** on the menu bar to suppress all current violations. This is sometimes referred to as "baselining".

- From **Solution Explorer**

To suppress a violation in **Solution Explorer**, set the rule's severity to **None**.
To suppress a violation in **Solution Explorer**, set the rule's severity to **None**.

- From the **rule set editor**

To suppress a violation from the rule set editor, uncheck the box next to its name or set **Action** to **None**.
To suppress a violation from the rule set editor, uncheck the box next to its name or set **Action** to **None**.

- From the **code editor**

To suppress a violation from the code editor, place the cursor in the line of code with the violation and press **Ctrl**+**.** to open the **Quick Actions** menu. Select **Suppress CAXXXX** > **in Source/in Suppression File**.
To suppress a violation from the code editor, place the cursor in the line of code with the violation and press **Ctrl**+**.** to open the **Quick Actions** menu. Select **Suppress CAXXXX** > **in Source/in Suppression File**.

![Suppress diagnostic from quick actions menu](media/suppress-diagnostic-from-editor.png)
![Suppress diagnostic from quick actions menu](media/suppress-diagnostic-from-editor.png)

- From the **Error List**

You can suppress one or many diagnostics from the **Error List** by selecting the ones you want to suppress, and then right-clicking and selecting **Suppress** > **In Source/In Suppression File**.
You can suppress one or many diagnostics from the **Error List** by selecting the ones you want to suppress, and then right-clicking and selecting **Suppress** > **In Source/In Suppression File**.

- If you suppress **In Source**, the **Preview Changes** dialog opens and shows a preview of the C# [#pragma warning](/dotnet/csharp/language-reference/preprocessor-directives/preprocessor-pragma-warning) or Visual Basic [#Disable warning](/dotnet/visual-basic/language-reference/directives/directives) directive that's added to the source code.
- If you suppress **In Source**, the **Preview Changes** dialog opens and shows a preview of the C# [#pragma warning](/dotnet/csharp/language-reference/preprocessor-directives/preprocessor-pragma-warning) or Visual Basic [#Disable warning](/dotnet/visual-basic/language-reference/directives/directives) directive that's added to the source code.

![Preview of adding #pragma warning in code file](media/pragma-warning-preview.png)
![Preview of adding #pragma warning in code file](media/pragma-warning-preview.png)

- If you select **In Suppression File**, the **Preview Changes** dialog opens and shows a preview of the <xref:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute> attribute that's added to the global suppressions file.
- If you select **In Suppression File**, the **Preview Changes** dialog opens and shows a preview of the <xref:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute> attribute that's added to the global suppressions file.

![Preview of adding SuppressMessage attribute to suppression file](media/preview-changes-in-suppression-file.png)
![Preview of adding SuppressMessage attribute to suppression file](media/preview-changes-in-suppression-file.png)

In the **Preview Changes** dialog, select **Apply**.
In the **Preview Changes** dialog, select **Apply**.

> [!NOTE]
> If you don't see the **Suppress** menu option in **Solution Explorer**, the violation is likely coming from build and not live analysis. The **Error List** displays diagnostics, or rule violations, from both live code analysis and build. Since the build diagnostics can be stale, for example, if you've edited the code to fix the violation but haven't rebuilt, you cannot suppress these diagnostics from the **Error List**. Diagnostics from live analysis, or IntelliSense, are always up-to-date with current sources and can be suppressed from the **Error List**. To exclude *build* diagnostics from your selection, switch the **Error List** source filter from **Build + IntelliSense** to **Intellisense Only**. Then, select the diagnostics you want to suppress and proceed as described previously.
>
> ![Error List source filter in Visual Studio](media/error-list-filter.png)
> [!NOTE]
> If you don't see the **Suppress** menu option in **Solution Explorer**, the violation is likely coming from build and not live analysis. The **Error List** displays diagnostics, or rule violations, from both live code analysis and build. Since the build diagnostics can be stale, for example, if you've edited the code to fix the violation but haven't rebuilt, you cannot suppress these diagnostics from the **Error List**. Diagnostics from live analysis, or IntelliSense, are always up-to-date with current sources and can be suppressed from the **Error List**. To exclude *build* diagnostics from your selection, switch the **Error List** source filter from **Build + IntelliSense** to **Intellisense Only**. Then, select the diagnostics you want to suppress and proceed as described previously.
>
> ![Error List source filter in Visual Studio](media/error-list-filter.png)

## Command-line usage

Expand Down Expand Up @@ -177,4 +177,4 @@ In a .NET Core project, if you add a reference to a project that has NuGet analy
- [Overview of Roslyn analyzers in Visual Studio](../code-quality/roslyn-analyzers-overview.md)
- [Submit a Roslyn analyzer bug](https://github.com/dotnet/roslyn-analyzers/issues)
- [Use rule sets](../code-quality/using-rule-sets-to-group-code-analysis-rules.md)
- [Suppress code analysis warnings](../code-quality/in-source-suppression-overview.md)
- [Suppress code analysis warnings](../code-quality/in-source-suppression-overview.md)
Loading